diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-01-10 20:07:01 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2018-01-17 21:22:53 -0800 |
| commit | c6bee70eec91debb6dafeb62b5dafce17a04fddb (patch) | |
| tree | f26e97140762e85508aedfb52deead56bab2a9e5 /doc/api | |
| parent | e42708c8e3d2c3917419ba7b536d3bb003b0df97 (diff) | |
| download | android-node-v8-c6bee70eec91debb6dafeb62b5dafce17a04fddb.tar.gz android-node-v8-c6bee70eec91debb6dafeb62b5dafce17a04fddb.tar.bz2 android-node-v8-c6bee70eec91debb6dafeb62b5dafce17a04fddb.zip | |
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 <gpunathi@in.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/child_process.md | 8 | ||||
| -rw-r--r-- | doc/api/http.md | 2 | ||||
| -rw-r--r-- | doc/api/readline.md | 4 |
3 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/child_process.md b/doc/api/child_process.md index 38c94dbf90..50b5be5473 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -1126,10 +1126,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 536d247226..02c78550e0 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 8619d75132..7ba1277dce 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' <!-- YAML |