Skip to content

Commit fd98d62

Browse files
Trottaddaleax
authored andcommitted
doc: revise style guide
Use italics for words-as-words within style guide. Other minor improvements. PR-URL: #25778 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]>
1 parent cc253b5 commit fd98d62

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/STYLE_GUIDE.md

+6-5
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@
1010
* A [plugin][] is available for some editors to automatically apply these
1111
rules.
1212
* 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_
1516
* Use [serial commas][].
16-
* Avoid personal pronouns in reference documentation ("I", "you", "we").
17+
* Avoid personal pronouns (_I_, _you_, _we_) in reference documentation.
1718
* Personal pronouns are acceptable in colloquial documentation such as guides.
1819
* 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_
2122
* When combining wrapping elements (parentheses and quotes), terminal
2223
punctuation should be placed:
2324
* Inside the wrapping element if the wrapping element contains a complete

0 commit comments

Comments
 (0)