Configure documentation URL for StringJoin check
#331
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
I've removed the unused static import, that caused the build to fail |
rickie
requested changes
Nov 3, 2022
| @@ -40,7 +40,7 @@ | |||
| @AutoService(BugChecker.class) | |||
| @BugPattern( | |||
| summary = "Prefer `String#join` over `String#format`", | |||
| linkType = NONE, | |||
| link = BUG_PATTERNS_BASE_URL + "StringJoin", | |||
There was a problem hiding this comment.
Suggested change
| link = BUG_PATTERNS_BASE_URL + "StringJoin", | |
| link = BUG_PATTERNS_BASE_URL + "StringJoin", | |
| linkType = CUSTOM, |
We should define the linkType as well, otherwise the URL won't be shown as the default is LinkType.AUTOGENERATED.
There was a problem hiding this comment.
Yes, this should be better now, thanks!
|
Nice catch @gtoison! (Note to self: find time to continue working on this branch.) |
Stephan202
approved these changes
Nov 3, 2022
rickie
approved these changes
Nov 3, 2022
There was a problem hiding this comment.
Changes LGTM!
W.r.t suggested commit message, I'd omit the word proper as no link is currently shown @Stephan202.
(Made that change)
rickie
changed the title
StringJoin check
It's also commit number 666, wonderful! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Thanks a lot for providing error-prone-support! I'm using it inside SonarQube and the links to the doc are useful.
The link for the StringJoin bug checker should be https://error-prone.picnic.tech/bugpatterns/StringJoin/