Skip to content

Commit eb1edd6

Browse files
authored
Merge pull request #4504 from ralfhandl/main-style-guide-bullet-lists
main: add guidance on bullet lists to style guide
2 parents 25fc465 + 66ab968 commit eb1edd6

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

style-guide.md

+6
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,12 @@ The following additional rules should be followed but currently are not enforced
2222
10. Use `<span id="thing"></span>` for link anchors. The `<a name="thing"></a>` format has been deprecated.
2323
11. Headings use [title case](https://en.wikipedia.org/wiki/Title_case) and are followed by a blank line.
2424
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.
25+
13. Bullet lists and punctuation:
26+
- If a bullet list item is a complete sentence or paragraph, start it with an uppercase letter and end it with a period.
27+
- 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.
28+
- 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.
29+
- Use a consistent bullet list item style for each bullet list.
30+
- 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.
2531

2632
Plus some suggestions, rather than rules:
2733

0 commit comments

Comments
 (0)