doc: escape brackets not used as markdown reference links #29809
Conversation
|
@nodejs/documentation This could use some reviews. |
nschonni
force-pushed
the
escape-brackets-in-docs
branch
2 times, most recently
from
2621fa3
to
080d8b1
Compare
| @@ -622,7 +622,7 @@ provided, `otherPublicKey` is expected to be a [`Buffer`][], | |||
| If `outputEncoding` is given a string is returned; otherwise, a | |||
| [`Buffer`][] is returned. | |||
|
|
|||
| ### diffieHellman.generateKeys([encoding]) | |||
| ### diffieHellman.generateKeys(\[encoding\]) | |||
There was a problem hiding this comment.
This escaping of the few instances [encoding] in the headings are the only functional difference that this rule caught. Before it was adding a hyperlink in the title because that bracket work is used as a reference link in this document
|
Resolved the few merge issues and pointed out the only instance where this fixes a rendering issue |
nschonni
force-pushed
the
escape-brackets-in-docs
branch
from
080d8b1
to
7eb0e21
Compare
These can turn into links if reference links are added to the document
nschonni
force-pushed
the
escape-brackets-in-docs
branch
from
7eb0e21
to
d224e9b
Compare
|
Presumably there's a lint rule that can be added/enabled for this? |
|
There are probably many currently-open PRs that will add more unescaped brackets when they land. I'm OK with that, though, if there's a lint rule on the horizon. We can fix up those instances when the lint rule lands. |
Trott
added
the
author ready
|
It would be covered by some of the rules in nodejs/remark-preset-lint-node#21 that are currently disabled. I'll go check to see if some of them can be re-enabled with the PRs that landed |
|
Landed in 81bc7b3 |
These can turn into links if reference links are added to the document PR-URL: #29809 Reviewed-By: Rich Trott <rtrott@gmail.com>
|
|
These can turn into links if reference links are added to the document PR-URL: #29809 Reviewed-By: Rich Trott <rtrott@gmail.com>
Split from #29558
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes