Skip to content

Commit 9b53c58

Browse files
committed
doc: add YAML parsers for removed sections
1 parent 208cb4f commit 9b53c58

File tree

3 files changed

+15
-1
lines changed

3 files changed

+15
-1
lines changed

doc/api/errors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1855,6 +1855,7 @@ A module file could not be resolved while attempting a [`require()`][] or
18551855
### ERR_FS_WATCHER_ALREADY_STARTED
18561856
<!-- YAML
18571857
added: v10.0.0
1858+
removed: v10.8.0
18581859
-->
18591860
An attempt was made to start a watcher returned by `fs.watch()` that has
18601861
already been started.
@@ -1863,6 +1864,7 @@ already been started.
18631864
### ERR_FS_WATCHER_NOT_STARTED
18641865
<!-- YAML
18651866
added: v10.0.0
1867+
removed: v10.8.0
18661868
-->
18671869

18681870
An attempt was made to initiate operations on a watcher returned by

tools/doc/common.js

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ function extractAndParseYAML(text) {
3434
meta.deprecated = arrify(meta.deprecated);
3535
}
3636

37+
if (meta.removed) {
38+
meta.removed = arrify(meta.removed);
39+
}
40+
3741
meta.changes = meta.changes || [];
3842

3943
return meta;

tools/doc/html.js

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,7 @@ function parseYAML(text) {
264264

265265
const added = { description: '' };
266266
const deprecated = { description: '' };
267+
const removed = { description: '' };
267268

268269
if (meta.added) {
269270
added.version = meta.added.join(', ');
@@ -276,9 +277,15 @@ function parseYAML(text) {
276277
`<span>Deprecated since: ${deprecated.version}</span>`;
277278
}
278279

280+
if (meta.removed) {
281+
removed.version = meta.removed.join(', ');
282+
removed.description = `<span>Removed in: ${removed.version}</span>`;
283+
}
284+
279285
if (meta.changes.length > 0) {
280286
if (added.description) meta.changes.push(added);
281287
if (deprecated.description) meta.changes.push(deprecated);
288+
if (removed.description) meta.changes.push(removed);
282289

283290
meta.changes.sort((a, b) => versionSort(a.version, b.version));
284291

@@ -299,7 +306,8 @@ function parseYAML(text) {
299306

300307
result += '</table>\n</details>\n';
301308
} else {
302-
result += `${added.description}${deprecated.description}\n`;
309+
result += `${added.description}${deprecated.description}` +
310+
`${removed.description}\n`;
303311
}
304312

305313
if (meta.napiVersion) {

0 commit comments

Comments
 (0)