|
10 | 10 | * A [plugin][] is available for some editors to automatically apply these
|
11 | 11 | rules.
|
12 | 12 | * Changes to documentation should be checked with `make lint-md`.
|
13 |
| -* American English spelling is preferred. "Capitalize" vs. "Capitalise", |
14 |
| - "color" vs. "colour", etc. |
| 13 | +* American English spelling is preferred. |
| 14 | + * OK: _capitalize_, _color_ |
| 15 | + * NOT OK: _capitalise_, _colour_ |
15 | 16 | * Use [serial commas][].
|
16 |
| -* Avoid personal pronouns in reference documentation ("I", "you", "we"). |
| 17 | +* Avoid personal pronouns (_I_, _you_, _we_) in reference documentation. |
17 | 18 | * Personal pronouns are acceptable in colloquial documentation such as guides.
|
18 | 19 | * Use gender-neutral pronouns and gender-neutral plural nouns.
|
19 |
| - * OK: "they", "their", "them", "folks", "people", "developers" |
20 |
| - * NOT OK: "his", "hers", "him", "her", "guys", "dudes" |
| 20 | + * OK: _they_, _their_, _them_, _folks_, _people_, _developers_ |
| 21 | + * NOT OK: _his_, _hers_, _him_, _her_, _guys_, _dudes_ |
21 | 22 | * When combining wrapping elements (parentheses and quotes), terminal
|
22 | 23 | punctuation should be placed:
|
23 | 24 | * Inside the wrapping element if the wrapping element contains a complete
|
|
0 commit comments