From 606df7c4e79324b9725bfcfe019a8b75bfa04c3f Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 27 Sep 2020 07:50:41 -0700 Subject: [PATCH] doc: make minor edits for consistency MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * We use _noop_ and _no-op_ in different docs. Use _no-op_ everywhere. * When referring to functions, add _()_ to indicate that. * Remove backticks from non-code _destroyed_. PR-URL: https://github.com/nodejs/node/pull/35377 Reviewed-By: Ruben Bridgewater Reviewed-By: Michaƫl Zasso Reviewed-By: Luigi Pinca --- doc/api/async_hooks.md | 2 +- doc/api/stream.md | 22 +++++++++++----------- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/api/async_hooks.md b/doc/api/async_hooks.md index 7d35800e086e8e..fcab499cbda658 100644 --- a/doc/api/async_hooks.md +++ b/doc/api/async_hooks.md @@ -182,7 +182,7 @@ of asynchronous operations. * Returns: {AsyncHook} A reference to `asyncHook`. Enable the callbacks for a given `AsyncHook` instance. If no callbacks are -provided enabling is a noop. +provided, enabling is a no-op. The `AsyncHook` instance is disabled by default. If the `AsyncHook` instance should be enabled immediately after creation, the following pattern can be used. diff --git a/doc/api/stream.md b/doc/api/stream.md index 8a69c5835bec76..49d05be4035212 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -389,7 +389,7 @@ added: v8.0.0 changes: - version: v14.0.0 pr-url: https://github.com/nodejs/node/pull/29197 - description: Work as noop when called on an already `destroyed` stream. + description: Work as a no-op on a stream that has already been destroyed. --> * `error` {Error} Optional, an error to emit with `'error'` event. @@ -404,8 +404,8 @@ This is a destructive and immediate way to destroy a stream. Previous calls to Use `end()` instead of destroy if data should flush before close, or wait for the `'drain'` event before destroying the stream. -Once `destroy()` has been called any further calls will be a noop and no -further errors except from `_destroy` may be emitted as `'error'`. +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. Implementors should not override this method, but instead implement [`writable._destroy()`][writable-_destroy]. @@ -975,7 +975,7 @@ added: v8.0.0 changes: - version: v14.0.0 pr-url: https://github.com/nodejs/node/pull/29197 - description: Work as noop when called on an already `destroyed` stream. + description: Work as a no-op on a stream that has already been destroyed. --> * `error` {Error} Error which will be passed as payload in `'error'` event @@ -986,8 +986,8 @@ event (unless `emitClose` is set to `false`). After this call, the readable stream will release any internal resources and subsequent calls to `push()` will be ignored. -Once `destroy()` has been called any further calls will be a noop and no -further errors except from `_destroy` may be emitted as `'error'`. +Once `destroy()` has been called any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. Implementors should not override this method, but instead implement [`readable._destroy()`][readable-_destroy]. @@ -1542,7 +1542,7 @@ added: v8.0.0 changes: - version: v14.0.0 pr-url: https://github.com/nodejs/node/pull/29197 - description: Work as noop when called on an already `destroyed` stream. + description: Work as a no-op on a stream that has already been destroyed. --> * `error` {Error} @@ -1555,8 +1555,8 @@ Implementors should not override this method, but instead implement The default implementation of `_destroy()` for `Transform` also emit `'close'` unless `emitClose` is set in false. -Once `destroy()` has been called any further calls will be a noop and no -further errors except from `_destroy` may be emitted as `'error'`. +Once `destroy()` has been called, any further calls will be a no-op and no +further errors except from `_destroy()` may be emitted as `'error'`. ### `stream.finished(stream[, options], callback)`