From 2e49010bc8f2d05f6b0eca66bd9fca08cb5745a5 Mon Sep 17 00:00:00 2001 From: cjihrig Date: Sat, 6 Jun 2020 16:42:35 -0400 Subject: [PATCH] doc: make events Extends usage consistent The docs use `* Extends: {type}` to define inheritance. This commit updates the events documentation to be consistent. PR-URL: https://github.com/nodejs/node/pull/33777 Reviewed-By: Rich Trott Reviewed-By: Luigi Pinca --- doc/api/events.md | 4 +++- tools/doc/type-parser.js | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/api/events.md b/doc/api/events.md index 7b641138953cd3..9ceee6a30bf8bf 100644 --- a/doc/api/events.md +++ b/doc/api/events.md @@ -1277,11 +1277,13 @@ added: REPLACEME Removes the `listener` from the list of handlers for event `type`. -### Class: `NodeEventTarget extends EventTarget` +### Class: `NodeEventTarget` +* Extends: {EventTarget} + The `NodeEventTarget` is a Node.js-specific extension to `EventTarget` that emulates a subset of the `EventEmitter` API. diff --git a/tools/doc/type-parser.js b/tools/doc/type-parser.js index 0a5a795011a2b7..d77fd420d1ae26 100644 --- a/tools/doc/type-parser.js +++ b/tools/doc/type-parser.js @@ -127,7 +127,7 @@ const customTypesMap = { 'net.Socket': 'net.html#net_class_net_socket', 'NodeEventTarget': - 'events.html#events_class_nodeeventtarget_extends_eventtarget', + 'events.html#events_class_nodeeventtarget', 'os.constants.dlopen': 'os.html#os_dlopen_constants',