summaryrefslogtreecommitdiff
path: root/doc/STYLE_GUIDE.md
diff options
context:
space:
mode:
authorAlexey Orlenko <eaglexrlnk@gmail.com>2017-05-21 02:12:15 +0300
committerAnna Henningsen <anna@addaleax.net>2017-05-23 21:14:56 +0200
commiteebc2622781d62125cd37a1c5ad06f26ba0a117f (patch)
tree372a6d62b47988f48ffc0b7ad645d280b12ca0c4 /doc/STYLE_GUIDE.md
parentef56d47f509cfe727db3fa3c842e2c66b916489d (diff)
downloadandroid-node-v8-eebc2622781d62125cd37a1c5ad06f26ba0a117f.tar.gz
android-node-v8-eebc2622781d62125cd37a1c5ad06f26ba0a117f.tar.bz2
android-node-v8-eebc2622781d62125cd37a1c5ad06f26ba0a117f.zip
doc: improve formatting of STYLE_GUIDE.md
* Wrap text at 80 characters. * Use periods consistently. PR-URL: https://github.com/nodejs/node/pull/13135 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Michael Dawson <mhdawson@ibm.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Diffstat (limited to 'doc/STYLE_GUIDE.md')
-rw-r--r--doc/STYLE_GUIDE.md21
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/STYLE_GUIDE.md b/doc/STYLE_GUIDE.md
index f11c5c0523..b535d2babc 100644
--- a/doc/STYLE_GUIDE.md
+++ b/doc/STYLE_GUIDE.md
@@ -1,16 +1,17 @@
# Style Guide
* Documents are written in markdown files.
-* Those files should be written in **`lowercase-with-dashes.md`.**
+* Those files should be written in **`lowercase-with-dashes.md`**.
* Underscores in filenames are allowed only when they are present in the
- topic the document will describe (e.g., `child_process`.)
+ topic the document will describe (e.g., `child_process`).
* Filenames should be **lowercase**.
* Some files, such as top-level markdown files, are exceptions.
* Older files may use the `.markdown` extension. These may be ported to `.md`
at will. **Prefer `.md` for all new documents.**
* Documents should be word-wrapped at 80 characters.
* The formatting described in `.editorconfig` is preferred.
- * A [plugin][] is available for some editors to automatically apply these rules.
+ * A [plugin][] is available for some editors to automatically apply these
+ rules.
* Mechanical issues, like spelling and grammar, should be identified by tools,
insofar as is possible. If not caught by a tool, they should be pointed out by
human reviewers.
@@ -18,12 +19,12 @@
"color" vs. "colour", etc.
* Though controversial, the [Oxford comma][] is preferred for clarity's sake.
* Generally avoid personal pronouns in reference documentation ("I", "you",
- "we".)
+ "we").
* Pronouns are acceptable in more colloquial documentation, like guides.
* Use **gender-neutral pronouns** and **mass nouns**. Non-comprehensive
examples:
* **OK**: "they", "their", "them", "folks", "people", "developers", "cats"
- * **NOT OK**: "his", "hers", "him", "her", "guys", "dudes".
+ * **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
@@ -54,10 +55,12 @@
your point, not as complete running programs. If a complete running program
is necessary, include it as an asset in `assets/code-examples` and link to
it.
-* When using underscores, asterisks and backticks please use proper escaping (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**)
-* References to constructor functions should use PascalCase
-* References to constructor instances should be camelCased
-* References to methods should be used with parentheses: `socket.end()` instead of `socket.end`
+* When using underscores, asterisks, and backticks, please use proper escaping
+ (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**).
+* References to constructor functions should use PascalCase.
+* References to constructor instances should use camelCase.
+* References to methods should be used with parentheses: for example,
+ `socket.end()` instead of `socket.end`.
[plugin]: http://editorconfig.org/#download
[Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma