Browse Source

doc: replace newlines in deprecation with space

As it is, each line in the deprecation heading which are wrapped at 80
characters in the *.md files, are shown in different lines. For example

    > Stability: 0 - Deprecated: Use
    > `Buffer.from(arrayBuffer[, byteOffset [, length]])`
    > instead.

is shown in three different lines. This patch replaces the newlines
with space characters, so that the output will be in single line.

PR-URL: https://github.com/nodejs/node/pull/11074

Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Timothy Gu <timothygu99@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
v6.x
Sakthipriyan Vairamani (thefourtheye) 8 years ago
committed by Myles Borins
parent
commit
50c2ecdf0e
No known key found for this signature in database GPG Key ID: 933B01F40B5CA946
  1. 2
      tools/doc/html.js

2
tools/doc/html.js

@ -183,7 +183,7 @@ function parseLists(input) {
headingIndex = -1; headingIndex = -1;
heading = null; heading = null;
} }
tok.text = parseAPIHeader(tok.text); tok.text = parseAPIHeader(tok.text).replace(/\n/g, ' ');
output.push({ type: 'html', text: tok.text }); output.push({ type: 'html', text: tok.text });
return; return;
} else if (state === 'MAYBE_STABILITY_BQ') { } else if (state === 'MAYBE_STABILITY_BQ') {

Loading…
Cancel
Save