From 862d005e603e8897336ee021094106c402603c2d Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sat, 6 Jun 2020 16:50:52 -0400 Subject: [PATCH] doc: make globals Extends usage consistent The docs use `* Extends: {type}` to define inheritance. This commit updates the globals documentation to be consistent. PR-URL: https://github.com/nodejs/node/pull/33777 Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca --- doc/api/globals.md | 4 +++- tools/doc/type-parser.js | 3 +-- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/doc/api/globals.md b/doc/api/globals.md index c9383ab9bdd605..096c73c72546fe 100644 --- a/doc/api/globals.md +++ b/doc/api/globals.md @@ -55,11 +55,13 @@ added: REPLACEME * Type: {AbortSignal} -### Class: `AbortSignal extends EventTarget` +### Class: `AbortSignal` +* Extends: {EventTarget} + The `AbortSignal` is used to notify observers when the `abortController.abort()` method is called. diff --git a/tools/doc/type-parser.js b/tools/doc/type-parser.js index dda2fe02d289ac..04659c715d3196 100644 --- a/tools/doc/type-parser.js +++ b/tools/doc/type-parser.js @@ -27,8 +27,7 @@ const customTypesMap = { 'this': `${jsDocPrefix}Reference/Operators/this`, 'AbortController': 'globals.html#globals_class_abortcontroller', - 'AbortSignal': - 'globals.html#globals_class_abortsignal_extends_eventtarget', + 'AbortSignal': 'globals.html#globals_class_abortsignal', 'ArrayBufferView': 'https://developer.mozilla.org/en-US/docs/Web/API/ArrayBufferView',