diff options
| author | Joram Wilander <jwawilander@gmail.com> | 2015-11-11 13:57:07 -0500 |
|---|---|---|
| committer | Joram Wilander <jwawilander@gmail.com> | 2015-11-11 13:57:07 -0500 |
| commit | 36036d9a48e6c64482f6ba0a8df222f83d3c0657 (patch) | |
| tree | 5dd45663e264e7544dbf97ca23440d497b10b507 /doc/process/documentation-guidelines.md | |
| parent | f8f0814a3796ffd80615c7722e096bef9ef17e73 (diff) | |
| parent | dd7f42adf50810b8316da8294cad51f088f08f8e (diff) | |
| download | chat-36036d9a48e6c64482f6ba0a8df222f83d3c0657.tar.gz chat-36036d9a48e6c64482f6ba0a8df222f83d3c0657.tar.bz2 chat-36036d9a48e6c64482f6ba0a8df222f83d3c0657.zip | |
Merge pull request #1381 from mishimi/patch-10
Updated bullet points section
Diffstat (limited to 'doc/process/documentation-guidelines.md')
| -rw-r--r-- | doc/process/documentation-guidelines.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/process/documentation-guidelines.md b/doc/process/documentation-guidelines.md index 59ed0a445..6f8c32e91 100644 --- a/doc/process/documentation-guidelines.md +++ b/doc/process/documentation-guidelines.md @@ -102,20 +102,20 @@ A support person should be able to say "Did you complete step 7?" instead of "Di ---- -### Lists end without periods +### End Lists Consistently -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. +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 is a sentence within a bullet point. This is the end of a bullet point without a period +- This is an example of a bullet point that ends with a period. ---- ##### Incorrect ---- -- This is an incorrect ending of a bullet point with a period. +- Example of an incorrect period at the end of a bullet point. ---- ### Avoid Passive Phrases |