From b52afa28440545c696d110caf9547af15bdca861 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Wed, 10 Jan 2018 20:07:01 -0800 Subject: [PATCH] doc: simplify sentences that use "considered" Change many instances of "x is considered to be y" to "x is y". PR-URL: https://github.com/nodejs/node/pull/18095 Reviewed-By: Gireesh Punathil Reviewed-By: Daniel Bevenius Reviewed-By: Colin Ihrig Reviewed-By: Richard Lau Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- doc/api/child_process.md | 8 ++++---- doc/api/http.md | 2 +- doc/api/readline.md | 4 ++-- doc/guides/maintaining-V8.md | 3 +-- 4 files changed, 8 insertions(+), 9 deletions(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 6fa943e7ee9bf9..2aeae73c728228 100755 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -1130,10 +1130,10 @@ process.send({ foo: 'bar', baz: NaN }); Child Node.js processes will have a [`process.send()`][] method of their own that allows the child to send messages back to the parent. -There is a special case when sending a `{cmd: 'NODE_foo'}` message. All messages -containing a `NODE_` prefix in its `cmd` property are considered to be reserved -for use within Node.js core and will not be emitted in the child's -[`process.on('message')`][] event. Rather, such messages are emitted using the +There is a special case when sending a `{cmd: 'NODE_foo'}` message. Messages +containing a `NODE_` prefix in the `cmd` property are reserved for use within +Node.js core and will not be emitted in the child's [`process.on('message')`][] +event. Rather, such messages are emitted using the `process.on('internalMessage')` event and are consumed internally by Node.js. Applications should avoid using such messages or listening for `'internalMessage'` events as it is subject to change without notice. diff --git a/doc/api/http.md b/doc/api/http.md index a4ed90269d61d3..c0e51d1d9d1151 100644 --- a/doc/api/http.md +++ b/doc/api/http.md @@ -622,7 +622,7 @@ Once a socket is assigned to this request and is connected added: v0.5.9 --> -* `timeout` {number} Milliseconds before a request is considered to be timed out. +* `timeout` {number} Milliseconds before a request times out. * `callback` {Function} Optional function to be called when a timeout occurs. Same as binding to the `timeout` event. Once a socket is assigned to this request and is connected diff --git a/doc/api/readline.md b/doc/api/readline.md index 8619d75132836d..7ba1277dce2d9c 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -60,8 +60,8 @@ The `'close'` event is emitted when one of the following occur: The listener function is called without passing any arguments. -The `readline.Interface` instance should be considered to be "finished" once -the `'close'` event is emitted. +The `readline.Interface` instance is finished once the `'close'` event is +emitted. ### Event: 'line'