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

Feature the suppress warnings on a template in the generated docs. #113

Open
timtebeek opened this issue Oct 25, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@timtebeek
Copy link
Contributor

What problem are you trying to solve?

As discovered on:

This template suppresses a warning:
https://github.com/PicnicSupermarket/error-prone-support/blob/9b4cbfb84dcebd9dbdd2235ca2b76675dfcb8f2e/error-prone-contrib/src/main/java/tech/picnic/errorprone/refasterrules/BigDecimalRules.java#L60

That label is what we want to feature in our recipe tags.

Describe the solution you'd like

Pull suppressed warnings from templates, and add those to the generated recipe tags.

Have you considered any alternatives or workarounds?

We could add support for tags into our recipe documentation annotations, but then those would not be picked up for the Picnic maintained Error Prone Support rules.

Additional context

https://error-prone.picnic.tech/refasterrules/BigDecimalRules/#bigdecimalvalueof

@timtebeek timtebeek added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
Status: Backlog
Development

No branches or pull requests

1 participant