diff options
| author | Sarat Addepalli <sarat.addepalli@paytm.com> | 2018-08-07 10:30:26 +0530 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-08-26 10:35:33 +0300 |
| commit | c917540f2280dd1047f9d44a4ba29ca90e64c2ab (patch) | |
| tree | 0ccbf0a04f28bfcd6e89694aa25d4673ce0370d9 /tools/doc/html.js | |
| parent | e10290cc67edd5118d4d72efa5336dc2ba652d05 (diff) | |
| download | node-new-c917540f2280dd1047f9d44a4ba29ca90e64c2ab.tar.gz | |
doc: support 'removed' field in doc YAML sections
PR-URL: https://github.com/nodejs/node/pull/22100
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Diffstat (limited to 'tools/doc/html.js')
| -rw-r--r-- | tools/doc/html.js | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/tools/doc/html.js b/tools/doc/html.js index d65a4b323a..f1ac9e144e 100644 --- a/tools/doc/html.js +++ b/tools/doc/html.js @@ -264,6 +264,7 @@ function parseYAML(text) { const added = { description: '' }; const deprecated = { description: '' }; + const removed = { description: '' }; if (meta.added) { added.version = meta.added.join(', '); @@ -276,9 +277,15 @@ function parseYAML(text) { `<span>Deprecated since: ${deprecated.version}</span>`; } + if (meta.removed) { + removed.version = meta.removed.join(', '); + removed.description = `<span>Removed in: ${removed.version}</span>`; + } + if (meta.changes.length > 0) { if (added.description) meta.changes.push(added); if (deprecated.description) meta.changes.push(deprecated); + if (removed.description) meta.changes.push(removed); meta.changes.sort((a, b) => versionSort(a.version, b.version)); @@ -299,7 +306,8 @@ function parseYAML(text) { result += '</table>\n</details>\n'; } else { - result += `${added.description}${deprecated.description}\n`; + result += `${added.description}${deprecated.description}` + + `${removed.description}\n`; } if (meta.napiVersion) { |