diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-10-23 21:28:42 -0700 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-10-26 08:39:41 -0700 |
| commit | 10040500da6af33b602e35c3f3bbe28cf76c4c4a (patch) | |
| tree | 69c2af94709de9ef7022c41423c0f618eb0d5e0a /doc/api/stream.md | |
| parent | 6858c7e3e7c30986d68a683d3d5e4ede4c0b529f (diff) | |
| download | android-node-v8-10040500da6af33b602e35c3f3bbe28cf76c4c4a.tar.gz android-node-v8-10040500da6af33b602e35c3f3bbe28cf76c4c4a.tar.bz2 android-node-v8-10040500da6af33b602e35c3f3bbe28cf76c4c4a.zip | |
doc: remove dashes
The use of dashes -- in general, but especially in our docs -- can be
problematic. It is used inconsistently and there is always another form
of punctuation that is as good or better for the situation. In an effort
to reduce the number of variations we use to display the same types of
information, remove the various uses of dashes from the documentation.
PR-URL: https://github.com/nodejs/node/pull/30101
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/stream.md')
| -rw-r--r-- | doc/api/stream.md | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index ef0bbb5027..2e66bac0c0 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -33,13 +33,13 @@ second section explains how to create new types of streams. There are four fundamental stream types within Node.js: -* [`Writable`][] - streams to which data can be written (for example, +* [`Writable`][]: streams to which data can be written (for example, [`fs.createWriteStream()`][]). -* [`Readable`][] - streams from which data can be read (for example, +* [`Readable`][]: streams from which data can be read (for example, [`fs.createReadStream()`][]). -* [`Duplex`][] - streams that are both `Readable` and `Writable` (for example, +* [`Duplex`][]: streams that are both `Readable` and `Writable` (for example, [`net.Socket`][]). -* [`Transform`][] - `Duplex` streams that can modify or transform the data as it +* [`Transform`][]: `Duplex` streams that can modify or transform the data as it is written and read (for example, [`zlib.createDeflate()`][]). Additionally, this module includes the utility functions @@ -2508,7 +2508,7 @@ user programs. [`stream.write()`][stream-write]. * `encoding` {string} If the chunk is a string, then this is the encoding type. If chunk is a buffer, then this is the special - value - `'buffer'`, ignore it in this case. + value `'buffer'`. Ignore it in that case. * `callback` {Function} A callback function (optionally with an error argument and data) to be called after the supplied `chunk` has been processed. |