Skip to content

Commit

Permalink
doc: fix linting in doc-style-guide.md
Browse files Browse the repository at this point in the history
Disable lint checks (enable prohibited-strings remark-lint) for
doc-style-guide.md:66. This was producing lint errors in builds
on master.

PR-URL: #33787
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
  • Loading branch information
rexagod authored and codebytere committed Jul 9, 2020
1 parent 3b43741 commit d547d1c
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/guides/doc-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,15 @@
<!-- lint disable prohibited-strings remark-lint-->
* 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-->
* For headings, use sentence case, not title case.
<!-- lint enable prohibited-strings remark-lint-->
* 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
confusion about whether _V8_ refers to Node.js 8.x or the V8 JavaScript
engine.
<!-- lint enable prohibited-strings remark-lint-->
* OK: _Node.js 14.x_, _Node.js 14.3.1_
* NOT OK: _Node.js v14_

Expand Down

0 comments on commit d547d1c

Please sign in to comment.