From 13d34dc18a205e4bd1f000b76aef497d861bbe8a Mon Sep 17 00:00:00 2001 From: Sho Miyamoto Date: Thu, 22 Feb 2018 05:09:55 +0900 Subject: [PATCH 1/2] doc: remove `Returns: {undefined}` --- doc/api/async_hooks.md | 6 ------ doc/api/fs.md | 1 - doc/api/http2.md | 8 -------- 3 files changed, 15 deletions(-) diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index a96fd042930081..66ce8d4d1d79df 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -692,8 +692,6 @@ deprecated: REPLACEME --> > Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead. -* Returns: {undefined} - Call all `before` callbacks to notify that a new asynchronous execution context is being entered. If nested calls to `emitBefore()` are made, the stack of `asyncId`s will be tracked and properly unwound. @@ -710,8 +708,6 @@ deprecated: REPLACEME --> > Stability: 0 - Deprecated: Use [`asyncResource.runInAsyncScope()`][] instead. -* Returns: {undefined} - Call all `after` callbacks. If nested calls to `emitBefore()` were made, then make sure the stack is unwound properly. Otherwise an error will be thrown. @@ -727,8 +723,6 @@ alternative. #### `asyncResource.emitDestroy()` -* Returns: {undefined} - Call all `destroy` hooks. This should only ever be called once. An error will be thrown if it is called more than once. This **must** be manually called. If the resource is left to be collected by the GC then the `destroy` hooks will diff --git a/doc/api/fs.md b/doc/api/fs.md index ae559d0ecff744..ea01cda19bbafe 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -796,7 +796,6 @@ changes: * `path` {string|Buffer|URL} * `mode` {integer} **Default:** `fs.constants.F_OK` -* Returns: {undefined} Synchronously tests a user's permissions for the file or directory specified by `path`. The `mode` argument is an optional integer that specifies the diff --git a/doc/api/http2.md b/doc/api/http2.md index efacbe149b7860..d40d1cd8306de0 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -327,7 +327,6 @@ added: v8.4.0 * `code` {number} The HTTP/2 error code to send in the final `GOAWAY` frame. If unspecified, and `error` is not undefined, the default is `INTERNAL_ERROR`, otherwise defaults to `NO_ERROR`. -* Returns: {undefined} Immediately terminates the `Http2Session` and the associated `net.Socket` or `tls.TLSSocket`. @@ -470,7 +469,6 @@ added: v8.4.0 * `msecs` {number} * `callback` {Function} -* Returns: {undefined} Used to set a callback function that is called when there is no activity on the `Http2Session` after `msecs` milliseconds. The given `callback` is @@ -882,7 +880,6 @@ added: v8.4.0 `http2.constants.NGHTTP2_NO_ERROR` (`0x00`) * `callback` {Function} An optional function registered to listen for the `'close'` event. -* Returns: {undefined} Closes the `Http2Stream` instance by sending an `RST_STREAM` frame to the connected HTTP/2 peer. @@ -933,7 +930,6 @@ added: v8.4.0 and `256` (inclusive). * `silent` {boolean} When `true`, changes the priority locally without sending a `PRIORITY` frame to the connected peer. -* Returns: {undefined} Updates the priority for this `Http2Stream` instance. @@ -994,7 +990,6 @@ added: v8.4.0 * `msecs` {number} * `callback` {Function} -* Returns: {undefined} ```js const http2 = require('http2'); @@ -1119,7 +1114,6 @@ added: v8.4.0 --> * `headers` {HTTP2 Headers Object} -* Returns: {undefined} Sends an additional informational `HEADERS` frame to the connected HTTP/2 peer. @@ -1163,7 +1157,6 @@ added: v8.4.0 * `pushStream` {ServerHttp2Stream} The returned pushStream object. * `headers` {HTTP2 Headers Object} Headers object the pushStream was initiated with. -* Returns: {undefined} Initiates a push stream. The callback is invoked with the new `Http2Stream` instance created for the push stream passed as the second argument, or an @@ -1198,7 +1191,6 @@ added: v8.4.0 include payload data. * `getTrailers` {Function} Callback function invoked to collect trailer headers. -* Returns: {undefined} ```js const http2 = require('http2'); From 741aeded18055e52a0fa01230c7a4dacfa27547b Mon Sep 17 00:00:00 2001 From: Sho Miyamoto Date: Sat, 24 Feb 2018 18:39:21 +0900 Subject: [PATCH 2/2] doc: remove a missed `Returns {undefined}` --- doc/api/http2.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/api/http2.md b/doc/api/http2.md index d40d1cd8306de0..e8df18affb4993 100644 --- a/doc/api/http2.md +++ b/doc/api/http2.md @@ -528,7 +528,6 @@ added: v8.4.0 --> * `settings` {HTTP2 Settings Object} -* Returns {undefined} Updates the current local settings for this `Http2Session` and sends a new `SETTINGS` frame to the connected HTTP/2 peer.