Skip to content

Commit

Permalink
Update README, improve suppression section
Browse files Browse the repository at this point in the history
  • Loading branch information
jsotuyod committed Feb 20, 2019
1 parent a09618f commit 7534d28
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ apply plugin: 'com.monits.staticCodeAnalysis'

The plugin is compatible with Gradle 2.3+, Gradle 3.+ and Gradle 4.+. We are commited to supporting at least the last 2 major gradle versions.

It supports all versions of the Android plugin from 1.1.0 onwards, up to 3.2.0
It supports all versions of the Android plugin from 1.1.0 onwards. It's been tested up to 3.3.1.


## DSL
Expand Down Expand Up @@ -145,8 +145,14 @@ As always feel free to contribute in any shape or form, we look forward to your

## Suppressing warnings

This is **not** the trick to break the rules but this **is** the way you should face those **few exceptions** to the rules.
Since every tool has its own mechanism, you should refer to its documentation:
If you re seeing things being reported which you think shouldn't it could be one of two things:

1. It's a false-positive. The tool is convinced of a violation that is simply not there. These should be reported to
the tool's developers in a Github issue.
2. You have found yourself in a corner case, where the rule, even 'though correct, doesn't really apply to a particular snippet of code.
These should be **absolute exceptions**, if you find yourself in this scenario all the time, consider modifying the set of applied rules.

Since every tool has its own suppression mechanism, you should refer to its documentation:

- Android Lint: [Documentation](http://tools.android.com/tips/lint/suppressing-lint-warnings)
- Checkstyle: [Documentation](http://checkstyle.sourceforge.net/config_annotation.html#SuppressWarnings)
Expand Down

0 comments on commit 7534d28

Please sign in to comment.