diff --git a/docs/repositories/commits.md b/docs/repositories/commits.md index 32aabd4594..a3995b2fdc 100644 --- a/docs/repositories/commits.md +++ b/docs/repositories/commits.md @@ -100,6 +100,17 @@ The following are example situations that can lead to potential issues: This happens when Codacy reports potential issues in files that weren't changed in your pull request. [Read more about this GitHub feature](https://developer.github.com/changes/2019-09-06-more-check-annotations-shown-in-files-changed-tab/). +### False positive issues + +!!! info + The False Positive detection is a business tier feature. If you are a Codacy Pro customer interested in upgrading to gain access to this feature, reach out to our customer success team. + +If your commit includes issues detected as false positives, an **Ignore all false positives** option will appear above the first issue in the list. This allows you to bulk ignore all detected false positives at once. + +For more details on managing false positives, see [Managing system-detected false positives](issues.md#managing-system-detected-false-positives). + +![Detected false positives](images/pull-requests-false-positives.png) + ## Duplication tab {: id="duplication-tabs"} The **Duplication** tab displays the lists of clones (duplicated code blocks) that the {{ page.meta.page_name }} adds or fixes. You can click a clone to expand it and inspect the code. diff --git a/docs/repositories/images/issues-false-positive-context.png b/docs/repositories/images/issues-false-positive-context.png new file mode 100644 index 0000000000..55edb62216 Binary files /dev/null and b/docs/repositories/images/issues-false-positive-context.png differ diff --git a/docs/repositories/images/issues-false-positive-menu.png b/docs/repositories/images/issues-false-positive-menu.png new file mode 100644 index 0000000000..3710911a33 Binary files /dev/null and b/docs/repositories/images/issues-false-positive-menu.png differ diff --git a/docs/repositories/images/pull-requests-false-positives.png b/docs/repositories/images/pull-requests-false-positives.png new file mode 100644 index 0000000000..481f123f32 Binary files /dev/null and b/docs/repositories/images/pull-requests-false-positives.png differ diff --git a/docs/repositories/issues.md b/docs/repositories/issues.md index ca1e50163e..bedd8f793c 100644 --- a/docs/repositories/issues.md +++ b/docs/repositories/issues.md @@ -87,6 +87,22 @@ Use the options in the menu of each issue to: ![Issue shortcuts menu](images/issues-menu.png) +## Managing system-detected false positives + +!!! info + The False Positive detection is a business tier feature. If you are a Codacy Pro customer interested in upgrading to gain access to this feature, reach out to our customer success team. + +Codacy can automatically detect issues that may be false positives. If the system indicates that an issue is a **False Positive**, you have two options: + +- **Ignore false positive** will ignore the issue and hide it from the list, as with other ignored issues. +- **Not a false positive** removes the False Positive label from the issue. + +![Managing system-detected false positives](images/issues-false-positive-menu.png) + +Expanding the issue will also display an explanation as to why this issue was deemed to be a false positive: + +![False positive issue context](images/issues-false-positive-context.png) + ## Restoring ignored issues To see the list of ignored issues, click the **Ignored** tab.