-
Notifications
You must be signed in to change notification settings - Fork 44
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
Wrapping a rule with a macro of the same name prevents the rule from being documented #98
Comments
Adding to the feature request. We want to pull up docstrings from the wrapped rule to the description. But we also want to be able to override the docstring from the wrapper. This is especially important for computed, mandatory arguments. Consider this case:
|
I think the solution is to give up on macros being a "tidy abstraction" for the underlying rule, and just be honest with users that both exist.
Things like attribute defaults still get documented on the underlying rule. |
One pattern in use in repos is to override a rule with a macro so that additional targets can be generated without needing to rewrite existing callers. An example of this approach can be seen in this PR.
stardoc
will document the macro, but will not find the wrapped rule, and so will not correctly document the project.The text was updated successfully, but these errors were encountered: