diff options
| author | Gibson Fahnestock <gibfahn@gmail.com> | 2017-06-18 20:53:54 +0100 |
|---|---|---|
| committer | Ruben Bridgewater <ruben@bridgewater.de> | 2017-09-28 02:26:56 -0300 |
| commit | 1175c9dca38e7ce5840dec3905586db9e2bbb4c1 (patch) | |
| tree | 524b3f5b897e636f5f490081c70cc22763f2deee /doc/api/stream.md | |
| parent | ccfcd8873cf4966380322f89e34ce47441868c9d (diff) | |
| download | node-new-1175c9dca38e7ce5840dec3905586db9e2bbb4c1.tar.gz | |
doc: standardize function param/object prop style
PR-URL: https://github.com/nodejs/node/pull/13769
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index 8aaa4ff2e6..8a758d75f3 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1624,7 +1624,7 @@ changes: any JavaScript value. * `encoding` {string} Encoding of string chunks. Must be a valid Buffer encoding, such as `'utf8'` or `'ascii'` -* Returns {boolean} `true` if additional chunks of data may continued to be +* Returns: {boolean} `true` if additional chunks of data may continued to be pushed; `false` otherwise. When `chunk` is a `Buffer`, `Uint8Array` or `string`, the `chunk` of data will |