diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-01-28 15:43:34 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-01-30 21:33:15 -0800 |
| commit | d34671ab7933be28586d3ef7df6515b84f6b6974 (patch) | |
| tree | 0c9dc376fa3d9a12d136dfcefe268a70466e037a /doc | |
| parent | dc1d331403feb3b9d1ca1a2bd306ca7428414ed8 (diff) | |
| download | android-node-v8-d34671ab7933be28586d3ef7df6515b84f6b6974.tar.gz android-node-v8-d34671ab7933be28586d3ef7df6515b84f6b6974.tar.bz2 android-node-v8-d34671ab7933be28586d3ef7df6515b84f6b6974.zip | |
doc: revise style guide
Use italics for words-as-words within style guide. Other minor
improvements.
PR-URL: https://github.com/nodejs/node/pull/25778
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/STYLE_GUIDE.md | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md index c274f6023e..c046d12397 100644 --- a/doc/STYLE_GUIDE.md +++ b/doc/STYLE_GUIDE.md @@ -10,14 +10,15 @@ * A [plugin][] is available for some editors to automatically apply these rules. * Changes to documentation should be checked with `make lint-md`. -* American English spelling is preferred. "Capitalize" vs. "Capitalise", - "color" vs. "colour", etc. +* American English spelling is preferred. + * OK: _capitalize_, _color_ + * NOT OK: _capitalise_, _colour_ * Use [serial commas][]. -* Avoid personal pronouns in reference documentation ("I", "you", "we"). +* Avoid personal pronouns (_I_, _you_, _we_) in reference documentation. * Personal pronouns are acceptable in colloquial documentation such as guides. * Use gender-neutral pronouns and gender-neutral plural nouns. - * OK: "they", "their", "them", "folks", "people", "developers" - * NOT OK: "his", "hers", "him", "her", "guys", "dudes" + * OK: _they_, _their_, _them_, _folks_, _people_, _developers_ + * NOT OK: _his_, _hers_, _him_, _her_, _guys_, _dudes_ * When combining wrapping elements (parentheses and quotes), terminal punctuation should be placed: * Inside the wrapping element if the wrapping element contains a complete |