Link to Picnic's Error Prone Support documentation based on OnlineDocumentation #78
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
timtebeek
commented
Mar 8, 2024
| @@ -466,6 +467,10 @@ private String recipeDescriptor(JCTree.JCClassDecl classDecl, String defaultDisp | |||
| } | |||
| } | |||
| break; | |||
| } else if ("tech.picnic.errorprone.refaster.annotation.OnlineDocumentation".equals(annotationFqn)) { | |||
| if (annotation.getArguments().isEmpty()) { | |||
There was a problem hiding this comment.
It seems rare / unused to have any value here ; they mostly rely on the default value, which isn't immediately easily accessible here for as much as I can tell. Hence why I went for the easiest approach to have some links to the docs already, which we can refine later.
knutwannheden
approved these changes
Mar 8, 2024
12 tasks
|
Amazing 🚀 ! |
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.
As discussed on #47 , this now links the external docs for additional context, as that shows a diff of before and after that might be helpful for users to go over as well, and gives credit there.
cc @rickie