-
Notifications
You must be signed in to change notification settings - Fork 402
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
Added test script for ensuring docs are up to date. #672
Conversation
@hlopko Do you have a second to review this PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, only nits. Thank you!
|
||
_common_attrs = { | ||
"aliases": attr.label_keyed_string_dict( | ||
doc = _tidy(""" | ||
doc = _tidy("""\ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why not skip the first line if empty in _tidy
and not require ? It seems fragile to remember to put \ there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Added support for ignoring first lines.
* Added test script for ensuring docs are up to date. * Fixed bug in doc attribute formatting. * Regenerate documentation * `_tidy` now ignores empty first lines * Updated comment * Regenerate documentation
Users should now see an error in their builds when they make a change which invalidates docs
![Screen Shot 2021-03-31 at 11 52 59 AM](https://user-images.githubusercontent.com/26427366/113195889-ae3bf480-9217-11eb-9d20-d8826a108f70.png)
Additionally, I've regenerated docs since they were out of date and fixed a bug in how docs were generated so we can correctly maintain indentations where desired.
Also I deleted the macos docs test since platform should have no impact on generating docs. This is purely a test of stardoc and the visibility of the bzl files which is platform agnostic.