doc: add formatting for version numbers to doc-style-guide.md · nodejs/node@095efac · GitHub

nodejs / node Public

• Notifications You must be signed in to change notification settings
• Fork 36.6k
• Star 120k

• Code
• Issues 633
• Pull requests 592
• Actions
• Projects
• Security and quality
• Insights

Additional navigation options

Commit 095efac

Browse filesBrowse the repository at this point in the historyBrowse files

Trott

authored and

codebytere

committed

doc: add formatting for version numbers to doc-style-guide.md

PR-URL: #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>

1 parent 843ab3e commit 095efac
Copy full SHA for 095efac

1 file changed

+6Lines changed: 6 additions & 0 deletions

File tree

Expand file treeCollapse file tree

Open diff view settings

Filter options

• doc/guides
  • doc-style-guide.md

Expand file treeCollapse file tree

Open diff view settings

Collapse file

‎doc/guides/doc-style-guide.md‎

Copy file name to clipboardExpand all lines: doc/guides/doc-style-guide.md

+6Lines changed: 6 additions & 0 deletions

• Display the source diff
• Display the rich diff

Original file line number	Diff line number	Diff line change
@@ -62,6 +62,12 @@
62	62	* NOT OK: It is important to note that, in all cases, the return value will be
63	63	a string regardless.
64	64	<!-- 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_
65	71
66	72	See also API documentation structure overview in [doctools README][].
67	73

0 commit comments

Comments

0 (0)