Documentation

Rules for AIP-192, covering documentation.

Rule name Description
absolute-links Comments must use absolute links
deprecated-comment Deprecated elements must have a corresponding comment.
has-comments Everything in a proto file must be commented.
no-html Comments must not use raw HTML
no-markdown-headings Public comments should not include Markdown headings.
no-markdown-tables Public comments should not include Markdown tables.
only-leading-comments All public comments should be leading comments.
trademarked-names Trademarked names should be used correctly.

Note: Because AIPs sometimes cover topics that have some overlap, some rules related to documentation may be included in the rules for other AIPs.