Skip to content
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

Update bigdecimalrulesrecipes$bigdecimalvalueofrecipe.md #312

Closed
wants to merge 1 commit into from

Conversation

al1lhomme
Copy link

add tag referencing sonar rule

What's changed?

i have add a tag section to reference the corresponding sonar rule

What's your motivation?

i was first searching this recipe by sonar rule reference, i dont find it and try other keywords

Anything in particular you'd like reviewers to focus on?

format is copied from https://docs.openrewrite.org/recipes/staticanalysis/writeoctalvaluesasdecimal#tags

@timtebeek
Copy link
Contributor

hi @al1lhomme ! Thanks for looking to improve the docs. There's a a few indirections here:

  1. our docs are generated based on tags defined on recipes, so a change here would be overwritten next time we generate the docs
  2. these recipes are generated based on Refaster rules, which do support documentation, but don't yet support tags specifically
  3. the refaster rules that serve as input for these recipes are maintained by our friends at Picnic: https://error-prone.picnic.tech/refasterrules/BigDecimalRules/#bigdecimalvalueof

That means your change here would only temporarily feature in the docs if merged. But if you change the JavaDoc here to add a reference to that tag, then it should show after the next release makes it in here. I hope that helps!

@timtebeek
Copy link
Contributor

timtebeek commented Oct 25, 2024

Although interestingly there's also this Suppress warnings line on their template:
https://github.com/PicnicSupermarket/error-prone-support/blob/9b4cbfb84dcebd9dbdd2235ca2b76675dfcb8f2e/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/BigDecimalRules.java#L60

Perhaps we ought to pull that into our tags to show those in the docs; neat! Logged as a suggestion here:

@timtebeek timtebeek closed this Oct 25, 2024
@al1lhomme al1lhomme deleted the patch-1 branch October 30, 2024 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

2 participants