doc: buffer TOC incorrectly contains brackets #9331
Comments
mscdex
added
buffer
|
Reverting fcee4d4 does not fix it. Must be something else. |
|
I found a way to fix the HTML generation so that the links will be visible. But the problem is, each and every part of the link will be pointing to different things. "What makes" will point to the actual section, |
thefourtheye
added a commit
to thefourtheye/io.js
that referenced
this issue
Nov 2, 2016
If there is a link in the headings, when the ToC is generated, that is
not properly linked and the square brackets are left as they are.
Even if we fix this, different parts of the heading will link to
different sections or even different pages. For example,
### What makes [`Buffer.allocUnsafe()`] and
[`Buffer.allocUnsafeSlow()`] "unsafe"?
will point to three different sections. `allocUnsafe` and
`allocUnsafeSlow` will link to their corresponding sections and all
other words actually link to the heading in the document. This could be
visually confusing.
Fixes: nodejs#9331
evanlucas
pushed a commit
that referenced
this issue
Nov 7, 2016
If there is a link in the headings, when the ToC is generated, that is
not properly linked and the square brackets are left as they are.
Even if we fix this, different parts of the heading will link to
different sections or even different pages. For example,
### What makes [`Buffer.allocUnsafe()`] and
[`Buffer.allocUnsafeSlow()`] "unsafe"?
will point to three different sections. `allocUnsafe` and
`allocUnsafeSlow` will link to their corresponding sections and all
other words actually link to the heading in the document. This could be
visually confusing.
PR-URL: #9416
Fixes: #9331
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Brian White <mscdex@mscdex.net>
MylesBorins
pushed a commit
that referenced
this issue
Nov 11, 2016
If there is a link in the headings, when the ToC is generated, that is
not properly linked and the square brackets are left as they are.
Even if we fix this, different parts of the heading will link to
different sections or even different pages. For example,
### What makes [`Buffer.allocUnsafe()`] and
[`Buffer.allocUnsafeSlow()`] "unsafe"?
will point to three different sections. `allocUnsafe` and
`allocUnsafeSlow` will link to their corresponding sections and all
other words actually link to the heading in the document. This could be
visually confusing.
PR-URL: #9416
Fixes: #9331
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Brian White <mscdex@mscdex.net>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
In the
bufferdoc TOC there is an entry called 'What makes [Buffer.allocUnsafe()] and [Buffer.allocUnsafeSlow()] "unsafe"?'. The brackets there should not be visible. The brackets do not exist in the v4.x docs. If I had to take a wild guess I would say the brackets were introduced when the 'deprecated' tags were added to every doc pages' TOC, as that is the immediate obvious difference between thebufferdoc TOC in v4.x and v6.x/latest.The text was updated successfully, but these errors were encountered: