Skip to content

Commit 3c91145

Browse files
aqrlnjasnell
authored andcommitted
doc: improve formatting of STYLE_GUIDE.md
* Wrap text at 80 characters. * Use periods consistently. PR-URL: #13135 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
1 parent 1d587ef commit 3c91145

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

doc/STYLE_GUIDE.md

+12-9
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,30 @@
11
# Style Guide
22

33
* Documents are written in markdown files.
4-
* Those files should be written in **`lowercase-with-dashes.md`.**
4+
* Those files should be written in **`lowercase-with-dashes.md`**.
55
* Underscores in filenames are allowed only when they are present in the
6-
topic the document will describe (e.g., `child_process`.)
6+
topic the document will describe (e.g., `child_process`).
77
* Filenames should be **lowercase**.
88
* Some files, such as top-level markdown files, are exceptions.
99
* Older files may use the `.markdown` extension. These may be ported to `.md`
1010
at will. **Prefer `.md` for all new documents.**
1111
* Documents should be word-wrapped at 80 characters.
1212
* The formatting described in `.editorconfig` is preferred.
13-
* A [plugin][] is available for some editors to automatically apply these rules.
13+
* A [plugin][] is available for some editors to automatically apply these
14+
rules.
1415
* Mechanical issues, like spelling and grammar, should be identified by tools,
1516
insofar as is possible. If not caught by a tool, they should be pointed out by
1617
human reviewers.
1718
* American English spelling is preferred. "Capitalize" vs. "Capitalise",
1819
"color" vs. "colour", etc.
1920
* Though controversial, the [Oxford comma][] is preferred for clarity's sake.
2021
* Generally avoid personal pronouns in reference documentation ("I", "you",
21-
"we".)
22+
"we").
2223
* Pronouns are acceptable in more colloquial documentation, like guides.
2324
* Use **gender-neutral pronouns** and **mass nouns**. Non-comprehensive
2425
examples:
2526
* **OK**: "they", "their", "them", "folks", "people", "developers", "cats"
26-
* **NOT OK**: "his", "hers", "him", "her", "guys", "dudes".
27+
* **NOT OK**: "his", "hers", "him", "her", "guys", "dudes"
2728
* When combining wrapping elements (parentheses and quotes), terminal
2829
punctuation should be placed:
2930
* Inside the wrapping element if the wrapping element contains a complete
@@ -54,10 +55,12 @@
5455
your point, not as complete running programs. If a complete running program
5556
is necessary, include it as an asset in `assets/code-examples` and link to
5657
it.
57-
* When using underscores, asterisks and backticks please use proper escaping (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**)
58-
* References to constructor functions should use PascalCase
59-
* References to constructor instances should be camelCased
60-
* References to methods should be used with parentheses: `socket.end()` instead of `socket.end`
58+
* When using underscores, asterisks, and backticks, please use proper escaping
59+
(**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**).
60+
* References to constructor functions should use PascalCase.
61+
* References to constructor instances should use camelCase.
62+
* References to methods should be used with parentheses: for example,
63+
`socket.end()` instead of `socket.end`.
6164

6265
[plugin]: http://editorconfig.org/#download
6366
[Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma

0 commit comments

Comments
 (0)