Skip to content

Commit 095efac

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 843ab3e commit 095efac

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
@@ -62,6 +62,12 @@
6262
* NOT OK: It is important to note that, in all cases, the return value will be
6363
a string regardless.
6464
<!-- lint enable prohibited-strings remark-lint-->
65+
* When referring to a version of Node.js in prose, use _Node.js_ and the version
66+
number. Do not prefix the version number with _v_ in prose. This is to avoid
67+
confusion about whether _v8_ refers to Node.js 8.x or the V8 JavaScript
68+
engine.
69+
* OK: _Node.js 14.x_, _Node.js 14.3.1_
70+
* NOT OK: _Node.js v14_
6571

6672
See also API documentation structure overview in [doctools README][].
6773

0 commit comments

Comments
 (0)