doc: do not link in the headings #9416
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
buffer
|
LGTM. I guess these kind of links never worked? |
addaleax
approved these changes
Nov 2, 2016
|
@silverwind Yes, when ToC is generated, the links on the markdown are NOT passed on. So they never worked I guess. |
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
thefourtheye
force-pushed
the
doc-buffer-header-dont-link
branch
from
2a8efb4 to
a22c6ec
Compare
|
@addaleax Thank you :-) Fixed it. |
|
LGTM |
cjihrig
approved these changes
Nov 2, 2016
jasnell
approved these changes
Nov 3, 2016
JungMinu
approved these changes
Nov 4, 2016
|
Landed in 5d0761f |
thefourtheye
added a commit
that referenced
this pull request
Nov 5, 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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Minwoo Jung <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Brian White <[email protected]>
evanlucas
pushed a commit
that referenced
this pull request
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Minwoo Jung <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Brian White <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
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 <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Minwoo Jung <[email protected]>
Reviewed-By: Roman Reiss <[email protected]>
Reviewed-By: Brian White <[email protected]>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Affected core subsystem(s)
doc buffer
Description of change
If there is a link in the headings, when the ToC is generated, that is
not properly linked, instead 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,
will point to three different sections.
allocUnsafeandallocUnsafeSlowwill link to their corresponding sections and allother words actully link to the heading in the document. This could be
visually confusing.
Fixes: #9331
cc @mscdex @silverwind