diff options
| author | Sam Roberts <vieuxtech@gmail.com> | 2019-01-09 09:32:08 -0800 |
|---|---|---|
| committer | Sam Roberts <vieuxtech@gmail.com> | 2019-01-09 10:03:31 -0800 |
| commit | c2d8a54474624f9894683a7d1e6b297f055487e5 (patch) | |
| tree | 190411898d8479cdd4b6ce0c7e696e36a0a6f0f4 /doc | |
| parent | b83088b0bb2b8dfa6ee72a807cc10fe1ac898278 (diff) | |
| download | node-new-c2d8a54474624f9894683a7d1e6b297f055487e5.tar.gz | |
doc: wrap and punctuate YAML description text
stream.md was the only YAML in doc/api that was using `>` for line
continuation, and only used it for a few descriptions, most used the
same wrapping style the rest of the documentation does.
Also added punctuation and capitialization to a few description
sentences.
Fixes: https://github.com/nodejs/node/pull/25413#discussion_r246451003
PR-URL: https://github.com/nodejs/node/pull/25419
Fixes: https://github.com/nodejs/node/issues/25413
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/stream.md | 21 |
1 files changed, 9 insertions, 12 deletions
diff --git a/doc/api/stream.md b/doc/api/stream.md index e6b4ffcc24..9650245345 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -788,9 +788,8 @@ added: v0.9.4 changes: - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/17979 - description: > - The `'readable'` is always emitted in the next tick after `.push()` - is called + description: The `'readable'` is always emitted in the next tick after + `.push()` is called. - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/18994 description: Using `'readable'` requires calling `.read()`. @@ -1510,13 +1509,12 @@ constructor and implement the `writable._write()` method. The changes: - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/18438 - description: > - Add `emitClose` option to specify if `'close'` is emitted on destroy + description: Add `emitClose` option to specify if `'close'` is emitted on + destroy. - version: v11.2.0 pr-url: https://github.com/nodejs/node/pull/22795 - description: > - Add `autoDestroy` option to automatically `destroy()` the stream - when it emits `'finish'` or errors + description: Add `autoDestroy` option to automatically `destroy()` the + stream when it emits `'finish'` or errors. --> * `options` {Object} @@ -1782,9 +1780,8 @@ constructor and implement the `readable._read()` method. changes: - version: v11.2.0 pr-url: https://github.com/nodejs/node/pull/22795 - description: > - Add `autoDestroy` option to automatically `destroy()` the stream - when it emits `'end'` or errors + description: Add `autoDestroy` option to automatically `destroy()` the + stream when it emits `'end'` or errors. --> * `options` {Object} @@ -1848,7 +1845,7 @@ added: v0.9.4 changes: - version: v10.0.0 pr-url: https://github.com/nodejs/node/pull/17979 - description: call `_read()` only once per microtick + description: Call `_read()` only once per microtick. --> * `size` {number} Number of bytes to read asynchronously |