diff --git a/README.md b/README.md index 265e72519..ea4a5d2df 100644 --- a/README.md +++ b/README.md @@ -166,6 +166,7 @@ Safe Logging can be found at [github.com/palantir/safe-logging](https://github.c - `OptionalOrElseThrowThrows`: Optional.orElseThrow argument must return an exception, not throw one. - `LambdaMethodReference`: Lambda should use a method reference. - `SafeLoggingExceptionMessageFormat`: SafeLoggable exceptions do not interpolate parameters. +- `StrictUnusedVariable`: Functions shouldn't have unused parameters. ## com.palantir.baseline-checkstyle Checkstyle rules can be suppressed on a per-line or per-block basis. (It is good practice to first consider formatting @@ -183,7 +184,7 @@ annotations cannot be used to suppress the violation. To suppress checks for par To disable certain checks for an entire file, apply [custom suppressions](http://checkstyle.sourceforge.net/config.html) in `.baseline/checkstyle/custom-suppressions.xml`. Avoid adding suppressions to the autogenerated `.baseline/checkstyle/checkstyle-suppressions.xml`, -as that file will be overriden on updates. +as that file will be overridden on updates. ### Copyright Checks diff --git a/baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/StrictUnusedVariable.java b/baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/StrictUnusedVariable.java index 856e53833..b5517c8c2 100644 --- a/baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/StrictUnusedVariable.java +++ b/baseline-error-prone/src/main/java/com/palantir/baseline/errorprone/StrictUnusedVariable.java @@ -102,6 +102,8 @@ @BugPattern( name = "StrictUnusedVariable", altNames = {"unused", "StrictUnusedVariable"}, + link = "https://github.com/palantir/gradle-baseline#baseline-error-prone-checks", + linkType = BugPattern.LinkType.CUSTOM, summary = "Unused.", providesFix = REQUIRES_HUMAN_ATTENTION, severity = WARNING, diff --git a/changelog/@unreleased/pr-829.v2.yml b/changelog/@unreleased/pr-829.v2.yml new file mode 100644 index 000000000..6d92945ae --- /dev/null +++ b/changelog/@unreleased/pr-829.v2.yml @@ -0,0 +1,5 @@ +type: fix +fix: + description: Add link to StrictUnusedVariable that directs users to baseline repo. + links: + - https://github.com/palantir/gradle-baseline/pull/829