diff --git a/docs/repositories/images/issues-reason-menu.png b/docs/repositories/images/issues-reason-menu.png new file mode 100644 index 0000000000..57a9b01439 Binary files /dev/null and b/docs/repositories/images/issues-reason-menu.png differ diff --git a/docs/repositories/images/issues-reason-options.png b/docs/repositories/images/issues-reason-options.png new file mode 100644 index 0000000000..0a1ab26efd Binary files /dev/null and b/docs/repositories/images/issues-reason-options.png differ diff --git a/docs/repositories/images/issues-reason-result.png b/docs/repositories/images/issues-reason-result.png new file mode 100644 index 0000000000..4259da55af Binary files /dev/null and b/docs/repositories/images/issues-reason-result.png differ diff --git a/docs/repositories/issues.md b/docs/repositories/issues.md index bedd8f793c..575b26c4b8 100644 --- a/docs/repositories/issues.md +++ b/docs/repositories/issues.md @@ -59,12 +59,16 @@ You can moreover define one or more of the following filters: Use the options in the menu of each issue to: - **Ignore the issue** and hide it from the list. + - **Select reason** for ignoring the issue. Codacy will no longer report the issue after the next analysis of your repository. For example, you can ignore issues that you disagree with because: - Your team won't tackle the issues in the immediate future - The issue isn't relevant in the specific context of your code - The issue is a false positive + - The issue is test code + + You can select one of the predefined reasons and give an optional comment to provide more context. See [how to restore ignored issues](#restoring-ignored-issues). @@ -85,7 +89,9 @@ Use the options in the menu of each issue to: Codacy will no longer analyze that file on your repository, so be sure that you're no longer interested in identifying any type of issues on that file. To remove an ignored file use the [Ignored Files tab](../repositories-configure/ignoring-files.md) in your repository settings. -![Issue shortcuts menu](images/issues-menu.png) +![Issue reason menu](images/issues-reason-menu.png) +![Issue reason options](images/issues-reason-options.png) +![Issue reason result](images/issues-reason-result.png) ## Managing system-detected false positives