Skip to content

Commit

Permalink
doc: add formatting for version numbers to doc-style-guide.md
Browse files Browse the repository at this point in the history
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]>
  • Loading branch information
Trott authored and codebytere committed Jul 9, 2020
1 parent b00996c commit 3b43741
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions doc/guides/doc-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,12 @@
* For headings, use sentence case, not title case.
* OK: _## Everybody to the limit_
* NOT OK: _## Everybody To The Limit_
* 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][].

Expand Down

0 comments on commit 3b43741

Please sign in to comment.