Commit d547d1c
doc: fix linting in doc-style-guide.md
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 <rtrott@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>1 parent 3b43741 commit d547d1c
1 file changed
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -61,14 +61,15 @@ | |||
| 61 | 61 | <!-- lint disable prohibited-strings remark-lint--> | |
| 62 | 62 | * NOT OK: It is important to note that, in all cases, the return value will be | |
| 63 | 63 | a string regardless. | |
| 64 | - <!-- lint enable prohibited-strings remark-lint--> | ||
| 65 | 64 | * For headings, use sentence case, not title case. | |
| 65 | + <!-- lint enable prohibited-strings remark-lint--> | ||
| 66 | 66 | * OK: _## Everybody to the limit_ | |
| 67 | 67 | * NOT OK: _## Everybody To The Limit_ | |
| 68 | 68 | * When referring to a version of Node.js in prose, use _Node.js_ and the version | |
| 69 | 69 | number. Do not prefix the version number with _v_ in prose. This is to avoid | |
| 70 | - confusion about whether _v8_ refers to Node.js 8.x or the V8 JavaScript | ||
| 70 | + confusion about whether _V8_ refers to Node.js 8.x or the V8 JavaScript | ||
| 71 | 71 | engine. | |
| 72 | + <!-- lint enable prohibited-strings remark-lint--> | ||
| 72 | 73 | * OK: _Node.js 14.x_, _Node.js 14.3.1_ | |
| 73 | 74 | * NOT OK: _Node.js v14_ | |
| 74 | 75 | ||
0 commit comments