Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Fix packaging rules documentation generation #251

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Nov 11, 2019
Merged

Fix packaging rules documentation generation #251

merged 2 commits into from
Nov 11, 2019

Conversation

brandjon
Copy link
Contributor

@brandjon brandjon commented Nov 7, 2019

Fix formatting of docstrings and regenerate the pages. Fixes #250.

@brandjon
Regenerate docs
d0d0c9e 
For some reason the rendered docs for the packaging rules' weren't up-to-date.

There's still some rendering issues due to the docstrings for these rules using
an outdated format.
@brandjon
Fix docstring formatting in packaging rules
6aee073 
Move argument docstrings to proper doc= arg on the attrs. Use markdown
formatting where possible. Regenerate docs.
@brandjon brandjon requested a review from laurentlb November 7, 2019 00:02
@brandjon brandjon requested a review from lberki as a code owner November 7, 2019 00:02
@brandjon brandjon self-assigned this Nov 7, 2019
@brandjon brandjon mentioned this pull request Nov 7, 2019
Merged
@brandjon brandjon requested a review from aiuto November 7, 2019 19:09
aiuto
aiuto approved these changes Nov 8, 2019
View reviewed changes
Copy link

@aiuto aiuto left a comment

Choose a reason for hiding this comment

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

The text is fine. The escaping of x vs. x is difficult to follow, but that may just be deficiencies of markdown.

docs/whl.md Show resolved Hide resolved
@brandjon
Copy link
Contributor Author

I originally tried replacing all the <code> tags with backticks, but it didn't render properly in args. That's a known issue in stardoc and I think it can already be fixed by upgrading to a newer stardoc and/or changing which template we use. Will file that detail away in the tracking bug.

@brandjon brandjon mentioned this pull request Nov 11, 2019
Closed
@brandjon brandjon merged commit 13bf8b7 into bazel-contrib:master Nov 11, 2019
@brandjon brandjon deleted the updatedocs branch November 11, 2019 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aiuto aiuto aiuto approved these changes

@laurentlb laurentlb Awaiting requested review from laurentlb

@lberki lberki Awaiting requested review from lberki

Assignees

@brandjon brandjon

Labels
cla: yes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Fix docgen for packaging rules
3 participants
@brandjon @aiuto @googlebot
Morty Proxy This is a proxified and sanitized view of the page, visit original site.