JavadocMethodCheck: removed unnecessary tokens from acceptable #15687
Conversation
rnveach
force-pushed
the
help_15683_excess_tokens
branch
from
5f0dc73 to
ad53809
Compare
so there should be changes in behavior, right ? |
| @@ -5,7 +5,7 @@ | |||
| accessModifiers = (default)public, protected, package, private | |||
| allowMissingParamTags = (default)false | |||
| allowMissingReturnTag = (default)false | |||
| tokens = METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF, RECORD_DEF, CLASS_DEF | |||
| tokens = METHOD_DEF, CTOR_DEF, ANNOTATION_FIELD_DEF, COMPACT_CTOR_DEF | |||
There was a problem hiding this comment.
this means breaking compatibility for users.
this check is very old, so users might have all this tokens.
no good reason to have such tokens, but it will still be compatibility issue - exception in run time after upgrade of checkstyle.
There was a problem hiding this comment.
@rnveach , are we in agreement ?
There was a problem hiding this comment.
I don't really see this as a breaking change, but you will do what you want anyways.
src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java
Show resolved
Hide resolved
|
@rnveach thanks for catching this and cleaning it up! |
romani
changed the title
|
We have bunch bug fixes already merged, but not released. |
### What changes were proposed in this pull request? This PR proposes to upgrade checkstyle to 10.20.0 ### Why are the changes needed? To pick up bug fixes made, e.g., checkstyle/checkstyle#15687 See also https://github.com/checkstyle/checkstyle/releases ### Does this PR introduce _any_ user-facing change? No, dev-only. ### How was this patch tested? Manually by: ```bash ./dev/lint-java ``` ### Was this patch authored or co-authored using generative AI tooling? No. Closes #48752 from HyukjinKwon/SPARK-50218. Authored-by: Hyukjin Kwon <[email protected]> Signed-off-by: Dongjoon Hyun <[email protected]>
Unrelated to #15683 but noticed when looking at it and the code.
We set required tokens in this Check which aren't needed. With them removed, we are able to remove a bit of code which was blocking violations on those tokens.
Tokens to remove from acceptable:
TokenTypes.CLASS_DEF,
TokenTypes.ENUM_DEF,
TokenTypes.INTERFACE_DEF,
TokenTypes.RECORD_DEF
Regression: https://rveach.no-ip.org/checkstyle/regression/4/
No differences.
Migration note:
Remove above tokens from config if used.