diff options
| author | mishimi <michelle@spinpunch.com> | 2015-11-10 10:18:08 -0800 |
|---|---|---|
| committer | mishimi <michelle@spinpunch.com> | 2015-11-10 10:18:08 -0800 |
| commit | 18fa3160a65106dd36c1514a14206e7b73ec6edf (patch) | |
| tree | 4744a3622bd059a3e1ce5ac317de7625631f5c62 /doc/process | |
| parent | 0980859042784082062c375a48e31b2465cf342e (diff) | |
| download | chat-18fa3160a65106dd36c1514a14206e7b73ec6edf.tar.gz chat-18fa3160a65106dd36c1514a14206e7b73ec6edf.tar.bz2 chat-18fa3160a65106dd36c1514a14206e7b73ec6edf.zip | |
Updated bullet points section
Diffstat (limited to 'doc/process')
| -rw-r--r-- | doc/process/documentation-guidelines.md | 10 |
1 files changed, 6 insertions, 4 deletions
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 |