Skip to content

Fix packaging rules documentation generation#251

Merged
brandjon merged 2 commits intobazel-contrib:masterfrom
brandjon:updatedocs
Nov 11, 2019
Merged

Fix packaging rules documentation generation#251
brandjon merged 2 commits intobazel-contrib:masterfrom
brandjon:updatedocs

Conversation

@brandjon
Copy link
Copy Markdown
Contributor

@brandjon brandjon commented Nov 7, 2019

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

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.
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 requested a review from aiuto November 7, 2019 19:09
Copy link
Copy Markdown

@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.

@brandjon
Copy link
Copy Markdown
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 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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix docgen for packaging rules

3 participants