Skip to content

Commit 2e7b8a9

Browse files
Sho MiyamotoMayaLekova
authored andcommitted
doc: remove Returns: {undefined}
Removed * Returns: {undefined} in doc/ to prevent confusing users PR-URL: nodejs#18951 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Benjamin Gruenbaum <[email protected]>
1 parent c7bb1ee commit 2e7b8a9

File tree

3 files changed

+0
-16
lines changed

3 files changed

+0
-16
lines changed

doc/api/async_hooks.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -686,8 +686,6 @@ deprecated: v9.6.0
686686
-->
687687
> Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead.
688688
689-
* Returns: {undefined}
690-
691689
Call all `before` callbacks to notify that a new asynchronous execution context
692690
is being entered. If nested calls to `emitBefore()` are made, the stack of
693691
`asyncId`s will be tracked and properly unwound.
@@ -704,8 +702,6 @@ deprecated: v9.6.0
704702
-->
705703
> Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead.
706704
707-
* Returns: {undefined}
708-
709705
Call all `after` callbacks. If nested calls to `emitBefore()` were made, then
710706
make sure the stack is unwound properly. Otherwise an error will be thrown.
711707

@@ -721,8 +717,6 @@ alternative.
721717

722718
#### `asyncResource.emitDestroy()`
723719

724-
* Returns: {undefined}
725-
726720
Call all `destroy` hooks. This should only ever be called once. An error will
727721
be thrown if it is called more than once. This **must** be manually called. If
728722
the resource is left to be collected by the GC then the `destroy` hooks will

doc/api/fs.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -788,7 +788,6 @@ changes:
788788

789789
* `path` {string|Buffer|URL}
790790
* `mode` {integer} **Default:** `fs.constants.F_OK`
791-
* Returns: {undefined}
792791

793792
Synchronously tests a user's permissions for the file or directory specified by
794793
`path`. The `mode` argument is an optional integer that specifies the

doc/api/http2.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -327,7 +327,6 @@ added: v8.4.0
327327
* `code` {number} The HTTP/2 error code to send in the final `GOAWAY` frame.
328328
If unspecified, and `error` is not undefined, the default is `INTERNAL_ERROR`,
329329
otherwise defaults to `NO_ERROR`.
330-
* Returns: {undefined}
331330

332331
Immediately terminates the `Http2Session` and the associated `net.Socket` or
333332
`tls.TLSSocket`.
@@ -470,7 +469,6 @@ added: v8.4.0
470469

471470
* `msecs` {number}
472471
* `callback` {Function}
473-
* Returns: {undefined}
474472

475473
Used to set a callback function that is called when there is no activity on
476474
the `Http2Session` after `msecs` milliseconds. The given `callback` is
@@ -530,7 +528,6 @@ added: v8.4.0
530528
-->
531529

532530
* `settings` {HTTP2 Settings Object}
533-
* Returns {undefined}
534531

535532
Updates the current local settings for this `Http2Session` and sends a new
536533
`SETTINGS` frame to the connected HTTP/2 peer.
@@ -882,7 +879,6 @@ added: v8.4.0
882879
`http2.constants.NGHTTP2_NO_ERROR` (`0x00`)
883880
* `callback` {Function} An optional function registered to listen for the
884881
`'close'` event.
885-
* Returns: {undefined}
886882

887883
Closes the `Http2Stream` instance by sending an `RST_STREAM` frame to the
888884
connected HTTP/2 peer.
@@ -933,7 +929,6 @@ added: v8.4.0
933929
and `256` (inclusive).
934930
* `silent` {boolean} When `true`, changes the priority locally without
935931
sending a `PRIORITY` frame to the connected peer.
936-
* Returns: {undefined}
937932

938933
Updates the priority for this `Http2Stream` instance.
939934

@@ -994,7 +989,6 @@ added: v8.4.0
994989

995990
* `msecs` {number}
996991
* `callback` {Function}
997-
* Returns: {undefined}
998992

999993
```js
1000994
const http2 = require('http2');
@@ -1117,7 +1111,6 @@ added: v8.4.0
11171111
-->
11181112

11191113
* `headers` {HTTP2 Headers Object}
1120-
* Returns: {undefined}
11211114

11221115
Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer.
11231116

@@ -1161,7 +1154,6 @@ added: v8.4.0
11611154
* `pushStream` {ServerHttp2Stream} The returned pushStream object.
11621155
* `headers` {HTTP2 Headers Object} Headers object the pushStream was
11631156
initiated with.
1164-
* Returns: {undefined}
11651157

11661158
Initiates a push stream. The callback is invoked with the new `Http2Stream`
11671159
instance created for the push stream passed as the second argument, or an
@@ -1196,7 +1188,6 @@ added: v8.4.0
11961188
include payload data.
11971189
* `getTrailers` {Function} Callback function invoked to collect trailer
11981190
headers.
1199-
* Returns: {undefined}
12001191

12011192
```js
12021193
const http2 = require('http2');

0 commit comments

Comments
 (0)