Browse code

Small edits and clean up

Signed-off-by: Fred Lifton <fred.lifton@docker.com>

Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)

Fred Lifton authored on 2015/07/21 03:59:48
Showing 1 changed files
... ...
@@ -93,9 +93,9 @@ More info from the always handy [Grammar Girl site](http://www.quickanddirtytips
93 93
 
94 94
 ### Pronouns
95 95
 
96
-It's okay to use first and second person pronouns. Specifically, use "we" to
96
+It's okay to use first and second person pronouns, especially if it lets you avoid a passive construction. Specifically, always use "we" to
97 97
 refer to Docker and "you" to refer to the user. For example, "We built the
98
-`exec` command so you can resize a TTY session."
98
+`exec` command so you can resize a TTY session." That said, in general, try to write simple, imperative sentences that avoid the use of pronouns altogether. Say "Now, enter your SSH key" rather than "You can now enter your SSH key."
99 99
 
100 100
 As much as possible, avoid using gendered pronouns ("he" and "she", etc.).
101 101
 Either recast the sentence so the pronoun is not needed or, less preferably,
... ...
@@ -128,7 +128,7 @@ capitalized (and words that would normally be capitalized in a sentence, e.g.,
128 128
 "Docker"). Do not use Title Case (i.e., capitalizing every word) for headings. Generally, we adhere to [AP style
129 129
 for titles](http://www.quickanddirtytips.com/education/grammar/capitalizing-titles).
130 130
 
131
-## Periods
131
+### Periods
132 132
 
133 133
 We prefer one space after a period at the end of a sentence, not two. 
134 134