doc: prevent one more false-positive linkification #20087
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesThis is the same tricky case as described in #19913, I've somehow missed it then.
Too common link reference in
cli.md
corrupts heading fromstring_decoder.md
in assembledall.html
(markdown references seem to be case-insensitive).Compare:
stringDecoder.end([buffer])
instring_decoder.html
andstringDecoder.end(buffer)
inall.html
withbuffer
parameter made mandatory and linkified.I've checked all the headings in
all.html
for any additional child HTML elements except expected (code
andspan
with#
TOC links) and found only this anomaly plus nits addressed in #20086. So, for now, there are no more similar issues.However, I do not know how we can prevent this false linkification and parameter corruption in the future. I can think of these options at least:
[]
in headings and demand this from now on by a rule. This may be a huge churn PR and a hard rule to follow unless added in doc linting.tools/doc/html.js
from adding any links to headings except for#
TOC links.cc @nodejs/documentation to consider this.
Also in passing:
Buffer
link refer toBuffer
class instead of the top module heading.