Skip to content

Commit

Permalink
doc: make globals Extends usage consistent
Browse files Browse the repository at this point in the history
The docs use `* Extends: {type}` to define inheritance. This
commit updates the globals documentation to be consistent.

PR-URL: #33777
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
  • Loading branch information
cjihrig authored and targos committed Apr 30, 2021
1 parent 2f7afd1 commit d9d7ebd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
4 changes: 3 additions & 1 deletion doc/api/globals.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,13 @@ added: REPLACEME

* Type: {AbortSignal}

### Class: `AbortSignal extends EventTarget`
### Class: `AbortSignal`
<!-- YAML
added: REPLACEME
-->

* Extends: {EventTarget}

The `AbortSignal` is used to notify observers when the
`abortController.abort()` method is called.

Expand Down
3 changes: 1 addition & 2 deletions tools/doc/type-parser.js
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit d9d7ebd

Please sign in to comment.