Skip to content

main: add guidance on bullet lists to style guide #4504

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

Merged
merged 1 commit into from
Mar 27, 2025
Merged

main: add guidance on bullet lists to style guide #4504

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions style-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ The following additional rules should be followed but currently are not enforced
10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated.
11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line.
12. Do not use [RFC2119 key words (MUST, MAY, ...)](https://datatracker.ietf.org/doc/html/rfc2119) in "Examples" sections or when explaining examples, and state requirements only in sections that are clearly normative.
13. Bullet lists and punctuation:
- If a bullet list item is a complete sentence or paragraph, start it with an uppercase letter and end it with a period.
- If a bullet list item is a word or short phrase, start it with an uppercase letter and do not end it with a punctuation character.
- If a bullet list item completes a stem sentence immediately preceding the bullet list, start it with a lowercase letter and end it with a period.
- Use a consistent bullet list item style for each bullet list.
- If in doubt which style to use for a new bullet list, look for similar lists in the same section or nearby sections and choose the same style.

Plus some suggestions, rather than rules:

Expand Down