-
Notifications
You must be signed in to change notification settings - Fork 329
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Find @Option
annotations without example
values
#3917
Find @Option
annotations without example
values
#3917
Conversation
As came up in Slack: openrewrite/gh-automation#45 (comment)
Should we possibly exclude |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. I miss some documentation for one test case
rewrite-java-test/src/test/java/org/openrewrite/java/recipes/MissingOptionExampleTest.java
Show resolved
Hide resolved
nice! just out of curiositiy, wouldn't be a |
Right now we produce a search marker, which has separate handling in the Moderne Platform to show the results there. That would be my main goal with this recipe to have a list of missing examples, and a hint at how to resolve that on a PR. Inserting a comment is also an option, but lacks that more sophisticated handling. |
Yes, I understand that they are SearchResults but simply adding “todo” to the comment would make visible for InteliJs TODO tab and combined with a Issue link it would be possible to have an automated todo list. But it will also work this way 😉
|
Adding a link to the recipe as it can be run from the platform: |
Looking over the results once more we can flag even fewer cases by ignoring primitives b044c5d |
As came up in Slack: openrewrite/gh-automation#45 (comment)