From 18fa3160a65106dd36c1514a14206e7b73ec6edf Mon Sep 17 00:00:00 2001 From: mishimi Date: Tue, 10 Nov 2015 10:18:08 -0800 Subject: Updated bullet points section --- doc/process/documentation-guidelines.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) (limited to 'doc/process/documentation-guidelines.md') diff --git a/doc/process/documentation-guidelines.md b/doc/process/documentation-guidelines.md index 59ed0a445..ab6662306 100644 --- a/doc/process/documentation-guidelines.md +++ b/doc/process/documentation-guidelines.md @@ -102,20 +102,22 @@ A support person should be able to say "Did you complete step 7?" instead of "Di ---- -### Lists end without periods +### End Lists Correctly -Sentences within bullet points or numbered lists should end in normal punctuation. The sentence or fragment at the end of a bullet point should not have a period. +Punctuate bullet points and numbered lists if they end in a full sentence. If they end in a fragment, do not add punctuation. ##### Correct ---- -- This is a sentence within a bullet point. This is the end of a bullet point without a period +- This bullet point ends with period. +- This bullet point does not end with a period because it ends with a fragment. Unlike the previous point ---- ##### Incorrect ---- -- This is an incorrect ending of a bullet point with a period. +- This bullet point does not end with a period. This is incorrect +- This bullet point does not end correctly. Like the previous point. ---- ### Avoid Passive Phrases -- cgit v1.2.3-1-g7c22 From dd7f42adf50810b8316da8294cad51f088f08f8e Mon Sep 17 00:00:00 2001 From: mishimi Date: Tue, 10 Nov 2015 10:59:12 -0800 Subject: Update documentation-guidelines.md --- doc/process/documentation-guidelines.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) (limited to 'doc/process/documentation-guidelines.md') diff --git a/doc/process/documentation-guidelines.md b/doc/process/documentation-guidelines.md index ab6662306..6f8c32e91 100644 --- a/doc/process/documentation-guidelines.md +++ b/doc/process/documentation-guidelines.md @@ -102,22 +102,20 @@ A support person should be able to say "Did you complete step 7?" instead of "Di ---- -### End Lists Correctly +### End Lists Consistently -Punctuate bullet points and numbered lists if they end in a full sentence. If they end in a fragment, do not add punctuation. +If one point in a bulleted list or numbered list ends with a period, end all points in the list with a period. If all points in the list are fragments, use no end punctuation. ##### Correct ---- -- This bullet point ends with period. -- This bullet point does not end with a period because it ends with a fragment. Unlike the previous point +- This is an example of a bullet point that ends with a period. ---- ##### Incorrect ---- -- This bullet point does not end with a period. This is incorrect -- This bullet point does not end correctly. Like the previous point. +- Example of an incorrect period at the end of a bullet point. ---- ### Avoid Passive Phrases -- cgit v1.2.3-1-g7c22