Skip to content

Commit bc2d1c9

Browse files
thefourtheyeevanlucas
authored andcommitted
doc: do not link in the headings
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]>
1 parent 90aac7c commit bc2d1c9

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/api/buffer.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ $ node --zero-fill-buffers
124124
<Buffer 00 00 00 00 00>
125125
```
126126

127-
### What makes [`Buffer.allocUnsafe()`] and [`Buffer.allocUnsafeSlow()`] "unsafe"?
127+
### What makes `Buffer.allocUnsafe()` and `Buffer.allocUnsafeSlow()` "unsafe"?
128128

129129
When calling [`Buffer.allocUnsafe()`] and [`Buffer.allocUnsafeSlow()`], the
130130
segment of allocated memory is *uninitialized* (it is not zeroed-out). While

0 commit comments

Comments
 (0)