1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: wrap and punctuate YAML description text

Browse Source 
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>
This commit is contained in:
Sam Roberts 2019-01-09 09:32:08 -08:00
parent b83088b0bb
commit c2d8a54474
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
doc/api/stream.md
View File

@ -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