Skip to content

Commit 1064258

Browse files
TrottMylesBorins
authored andcommitted
doc: remove bold typography from STYLE_GUIDE.md
Remove unnecessary bold typography from the style guide. PR-URL: #16085 Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Lance Ball <lball@redhat.com>
1 parent 08ca73f commit 1064258

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

doc/STYLE_GUIDE.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# Style Guide
22

3-
* Documents are written in markdown files.
4-
* Those files should be written in **`lowercase-with-dashes.md`**.
3+
* Documentation is written in markdown files with names formatted as
4+
`lowercase-with-dashes.md`.
55
* Underscores in filenames are allowed only when they are present in the
66
topic the document will describe (e.g., `child_process`).
7-
* Filenames should be **lowercase**.
87
* Some files, such as top-level markdown files, are exceptions.
98
* Documents should be word-wrapped at 80 characters.
109
* The formatting described in `.editorconfig` is preferred.
@@ -19,10 +18,10 @@
1918
* Generally avoid personal pronouns in reference documentation ("I", "you",
2019
"we").
2120
* Pronouns are acceptable in more colloquial documentation, like guides.
22-
* Use **gender-neutral pronouns** and **mass nouns**. Non-comprehensive
21+
* Use gender-neutral pronouns and mass nouns. Non-comprehensive
2322
examples:
24-
* **OK**: "they", "their", "them", "folks", "people", "developers", "cats"
25-
* **NOT OK**: "his", "hers", "him", "her", "guys", "dudes"
23+
* OK: "they", "their", "them", "folks", "people", "developers", "cats"
24+
* NOT OK: "his", "hers", "him", "her", "guys", "dudes"
2625
* When combining wrapping elements (parentheses and quotes), terminal
2726
punctuation should be placed:
2827
* Inside the wrapping element if the wrapping element contains a complete
@@ -54,7 +53,7 @@
5453
is necessary, include it as an asset in `assets/code-examples` and link to
5554
it.
5655
* When using underscores, asterisks, and backticks, please use proper escaping
57-
(**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**).
56+
(`\_`, `\*` and ``\` `` instead of `_`, `*` and `` ` ``).
5857
* References to constructor functions should use PascalCase.
5958
* References to constructor instances should use camelCase.
6059
* References to methods should be used with parentheses: for example,

0 commit comments

Comments
 (0)