Skip to content

Commit 7f428f2

Browse files
committed
docs(content-style-guide): add guidance on list delimiters
Signed-off-by: Jai Govindani <[email protected]>
1 parent d39e9b3 commit 7f428f2

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

contributing/content-style-guide.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,10 @@ For general guidelines, see “[Lists](https://brand.github.com/content/grammar#
235235

236236
Capitalize the first letter in each line of a list. Use periods at the end of lines in a list only if the line contains a complete sentence.
237237

238+
When writing a list of items that consist of primary and secondary text, such as a `term` and its definition, use a colon delimiter. The secondary text should be capitalized as if it was the beginning of the line. For example:
239+
* `foo`: Something that provides bar.
240+
* `bar`: Something provided by foo.
241+
238242
Formatting unordered lists:
239243
- If the order of items in the list is not important, alphabetize the list items.
240244
- If the order is important, then order the list by the importance to the reader (for example, moving from broadest audience and applicability to a more specialized audience).

0 commit comments

Comments
 (0)