Skip to content

Commit 3b43741

Browse files
Trottcodebytere
authored andcommitted
doc: add formatting for version numbers to doc-style-guide.md
PR-URL: #33755 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent b00996c commit 3b43741

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

doc/guides/doc-style-guide.md

+6
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,12 @@
6565
* For headings, use sentence case, not title case.
6666
* OK: _## Everybody to the limit_
6767
* NOT OK: _## Everybody To The Limit_
68+
* When referring to a version of Node.js in prose, use _Node.js_ and the version
69+
number. Do not prefix the version number with _v_ in prose. This is to avoid
70+
confusion about whether _v8_ refers to Node.js 8.x or the V8 JavaScript
71+
engine.
72+
* OK: _Node.js 14.x_, _Node.js 14.3.1_
73+
* NOT OK: _Node.js v14_
6874

6975
See also API documentation structure overview in [doctools README][].
7076

0 commit comments

Comments
 (0)