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

Ability to suppress macro documentation warnings #649

Open
c-parsons opened this issue Jun 12, 2019 · 3 comments
Open

Ability to suppress macro documentation warnings #649

c-parsons opened this issue Jun 12, 2019 · 3 comments

Comments

@c-parsons
Copy link

See bazelbuild/bazel#7977 (comment)

We would suggest that users set default values for rules via a wrapper macro. Wrapper macros become more annoying to write, though, if they need to mirror the full documentation of their rule.

We might consider using a meta tag to note that a macro should inherit (or link to) the documentation for the rule it wraps, and this should suppress buildifier warnings.

@laurentlb
Copy link
Contributor

@c-parsons
Copy link
Author

c-parsons commented Jun 12, 2019

So suppression with

# buildozer: disable=function-docstring

should work to suppress the docstring error?
Probably a good enough workaround for now.
I'm not sure suppressing warnings is a good permanent solution, given that we are recommending macro-wrapping-rule as a common pattern.

@aiuto
Copy link
Contributor

aiuto commented Jan 24, 2020

Also see #768

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants