Skip to content

doc: do not link in the headings

Rodrigo Muino Tomonari requested to merge github/fork/thefourtheye/doc-buffer-header-dont-link into master
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
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,

### 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 actully link to the heading in the document. This could be visually confusing.

Fixes: https://github.com/nodejs/node/issues/9331

cc @mscdex @silverwind

Merge request reports