Skip to content

Commit

Permalink
chore(docs): update docs to reflect 3.11 changes
Browse files Browse the repository at this point in the history
  • Loading branch information
j-lanson committed Feb 24, 2025
1 parent 14675a2 commit 6e0dcf2
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
7 changes: 3 additions & 4 deletions site/content/docs/guide/plugins/mitre-churn.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ in a project's history.

| Parameter | Type | Explanation |
|:--------------------|:---------|:--------------|
| `langs-file` | `String` | Path to a file specifying how to infer languages. |
| `churn-freq` | `Float` | Threshold for a Z-score, above which a commit is considered "high churn" |
| `commit-percentage` | `Float` | Threshold for a percentage of "high churn" commits permitted. |

Expand All @@ -30,9 +29,9 @@ in a project's history.
## Default Query: `mitre/churn`

Returns an array of churn Z-scores for all commits identified as modifying
source files. This is not _all_ commits, as the analysis uses heuristics based
on the provided `langs-file` to identify which files are likely source files,
and excludes commits which do not modify any likely source files.
source files. This is not _all_ commits, as the analysis uses the
`mitre/linguist` plugin to identify which files are likely source files, and
excludes commits which do not modify any likely source files.

## Explanation

Expand Down
4 changes: 2 additions & 2 deletions site/content/docs/guide/plugins/mitre-entropy.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ history.

| Parameter | Type | Explanation |
|:--------------------|:---------|:--------------|
| `langs-file` | `String` | Path to a file specifying how to infer languages. |
| `entropy-threshold` | `Float` | Threshold for a Z-score, above which a commit is considered "high entropy" |
| `commit-percentage` | `Float` | Threshold for a percentage of "high entropy" commits permitted. |

Expand All @@ -31,7 +30,8 @@ history.
## Default Query: `mitre/entropy`

Returns an array of commit entropies for commits identified as impacting
likely source files.
likely source files. Uses the `mitre/linguist` plugin to determine the likely
source files of the repository.

## Explanation

Expand Down

0 comments on commit 6e0dcf2

Please sign in to comment.