summaryrefslogtreecommitdiff
path: root/doc/api/stream.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2017-12-27 19:21:06 -0800
committerRich Trott <rtrott@gmail.com>2018-01-03 17:18:30 -0800
commit26607b825ebebe78a182951af164fd1e319dfe27 (patch)
treec32d12dd88fb3cdff39776371dbfd6f2e6946e03 /doc/api/stream.md
parentecf6e79362faad747f50405d7f36a5d5006c3e97 (diff)
downloadandroid-node-v8-26607b825ebebe78a182951af164fd1e319dfe27.tar.gz
android-node-v8-26607b825ebebe78a182951af164fd1e319dfe27.tar.bz2
android-node-v8-26607b825ebebe78a182951af164fd1e319dfe27.zip
doc: edit for concision
This removes some wordy phrases (notably "it is important to note that"). PR-URL: https://github.com/nodejs/node/pull/17891 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
-rw-r--r--doc/api/stream.md11
1 files changed, 5 insertions, 6 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md
index 741f105464..10bd951505 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -1426,12 +1426,11 @@ successfully or failed with an error. The first argument passed to the
`callback` must be the `Error` object if the call failed or `null` if the
write succeeded.
-It is important to note that all calls to `writable.write()` that occur between
-the time `writable._write()` is called and the `callback` is called will cause
-the written data to be buffered. Once the `callback` is invoked, the stream will
-emit a [`'drain'`][] event. If a stream implementation is capable of processing
-multiple chunks of data at once, the `writable._writev()` method should be
-implemented.
+All calls to `writable.write()` that occur between the time `writable._write()`
+is called and the `callback` is called will cause the written data to be
+buffered. Once the `callback` is invoked, the stream will emit a [`'drain'`][]
+event. If a stream implementation is capable of processing multiple chunks of
+data at once, the `writable._writev()` method should be implemented.
If the `decodeStrings` property is set in the constructor options, then
`chunk` may be a string rather than a Buffer, and `encoding` will