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]>
nodejs · Jun 18, 2020 · 095efac · 095efac
1 parent 843ab3e
commit 095efac
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md
@@ -62,6 +62,12 @@
   * NOT OK: It is important to note that, in all cases, the return value will be
     a string regardless.
   <!-- lint enable prohibited-strings remark-lint-->
+* When referring to a version of Node.js in prose, use _Node.js_ and the version
+  number. Do not prefix the version number with _v_ in prose. This is to avoid
+  confusion about whether _v8_ refers to Node.js 8.x or the V8 JavaScript
+  engine.
+  * OK: _Node.js 14.x_, _Node.js 14.3.1_
+  * NOT OK: _Node.js v14_
 
 See also API documentation structure overview in [doctools README][].