Skip to content

Commit a57eefc

Browse files
docs: section for managing false positives for issues (#2500)
* docs: section for managing false positives for issues * docs: update false positives CF-1932 * docs: add missing ! CF-1932 * Update docs/repositories/commits.md Co-authored-by: Cláudia <83641264+claudiacodacy@users.noreply.github.com> * Update docs/repositories/issues.md Co-authored-by: Cláudia <83641264+claudiacodacy@users.noreply.github.com> --------- Co-authored-by: Cláudia <83641264+claudiacodacy@users.noreply.github.com>
1 parent 4c4702c commit a57eefc

File tree

5 files changed

+27
-0
lines changed

5 files changed

+27
-0
lines changed

docs/repositories/commits.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,17 @@ The following are example situations that can lead to potential issues:
100100

101101
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/).
102102

103+
### False positive issues
104+
105+
!!! info
106+
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.
107+
108+
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.
109+
110+
For more details on managing false positives, see [Managing system-detected false positives](issues.md#managing-system-detected-false-positives).
111+
112+
![Detected false positives](images/pull-requests-false-positives.png)
113+
103114
## Duplication tab {: id="duplication-tabs"}
104115

105116
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.
242 KB
Loading
198 KB
Loading
268 KB
Loading

docs/repositories/issues.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,22 @@ Use the options in the menu of each issue to:
8787

8888
![Issue shortcuts menu](images/issues-menu.png)
8989

90+
## Managing system-detected false positives
91+
92+
!!! info
93+
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.
94+
95+
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:
96+
97+
- **Ignore false positive** will ignore the issue and hide it from the list, as with other ignored issues.
98+
- **Not a false positive** removes the False Positive label from the issue.
99+
100+
![Managing system-detected false positives](images/issues-false-positive-menu.png)
101+
102+
Expanding the issue will also display an explanation as to why this issue was deemed to be a false positive:
103+
104+
![False positive issue context](images/issues-false-positive-context.png)
105+
90106
## Restoring ignored issues
91107

92108
To see the list of ignored issues, click the **Ignored** tab.

0 commit comments

Comments
 (0)