From 83f499b271a7ed861fbc211a68cad985662124ef Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 5 Jun 2020 10:33:27 -0700 Subject: [PATCH] doc: add formatting for version numbers to doc-style-guide.md PR-URL: https://github.com/nodejs/node/pull/33755 Reviewed-By: Anna Henningsen Reviewed-By: Richard Lau Reviewed-By: Luigi Pinca Reviewed-By: Trivikram Kamat --- doc/guides/doc-style-guide.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index 9670088fefd82c..4429501e708514 100644 --- 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. +* 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][].