diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-06-05 10:33:27 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-06-07 12:33:14 -0700 |
| commit | eeede81c5ceadf405e22a84c921a9f06ab1ca6c2 (patch) | |
| tree | 3a9498f1edb5af716fa42032dab7cef97b8119c9 /doc | |
| parent | 101e0a9d140357ac0fb532723b06d36d8cc0fe6c (diff) | |
| download | node-new-eeede81c5ceadf405e22a84c921a9f06ab1ca6c2.tar.gz | |
doc: add formatting for version numbers to doc-style-guide.md
PR-URL: https://github.com/nodejs/node/pull/33755
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guides/doc-style-guide.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index 9670088fef..4429501e70 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. <!-- 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][]. |