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

Fix API documentation for common rules #1228

Merged
merged 4 commits into from
Jan 31, 2020
Merged

Fix API documentation for common rules #1228

merged 4 commits into from
Jan 31, 2020

Conversation

aherrmann
Copy link
Member

Closes #1122

The rules haskell_library|binary|test are exposed through wrapper macros, the rules themselves are hidden. As a consequence the API documentation doesn't show the doc attribute of the rule attributes. This PR makes the attributes explicit in the wrapper macros, and moves the attribute documentation into the docstring of the wrapper macros. Unfortunately, wrapper macros cannot inherit rule documentation. See bazelbuild/stardoc#27

These rules are exposed through wrapper macros and the attribute
doc-strings are not forwarded to the macro documentation.
@aherrmann
Copy link
Member Author

Rendered

Copy link
Contributor

@thufschmitt thufschmitt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! It's a bit sad that we can't benefit from **kwargs anymore, but that's a more than decent traedoff

@aherrmann aherrmann added the merge-queue merge on green CI label Jan 31, 2020
@mergify mergify bot merged commit bbe9dda into master Jan 31, 2020
@mergify mergify bot deleted the docs branch January 31, 2020 14:36
@mergify mergify bot removed the merge-queue merge on green CI label Jan 31, 2020
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

Successfully merging this pull request may close these issues.

The api documentation don't document the args for some rules
2 participants