Commit f58b530
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: #25413 (comment)
PR-URL: #25419
Fixes: #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>1 parent 8380bd4 commit f58b530
1 file changed
Lines changed: 9 additions & 12 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -788,9 +788,8 @@ added: v0.9.4 | |||
| 788 | 788 | changes: | |
| 789 | 789 | - version: v10.0.0 | |
| 790 | 790 | pr-url: https://github.com/nodejs/node/pull/17979 | |
| 791 | - description: > | ||
| 792 | - The `'readable'` is always emitted in the next tick after `.push()` | ||
| 793 | - is called | ||
| 791 | + description: The `'readable'` is always emitted in the next tick after | ||
| 792 | + `.push()` is called. | ||
| 794 | 793 | - version: v10.0.0 | |
| 795 | 794 | pr-url: https://github.com/nodejs/node/pull/18994 | |
| 796 | 795 | description: Using `'readable'` requires calling `.read()`. | |
@@ -1510,13 +1509,12 @@ constructor and implement the `writable._write()` method. The | |||
| 1510 | 1509 | changes: | |
| 1511 | 1510 | - version: v10.0.0 | |
| 1512 | 1511 | pr-url: https://github.com/nodejs/node/pull/18438 | |
| 1513 | - description: > | ||
| 1514 | - Add `emitClose` option to specify if `'close'` is emitted on destroy | ||
| 1512 | + description: Add `emitClose` option to specify if `'close'` is emitted on | ||
| 1513 | + destroy. | ||
| 1515 | 1514 | - version: v11.2.0 | |
| 1516 | 1515 | pr-url: https://github.com/nodejs/node/pull/22795 | |
| 1517 | - description: > | ||
| 1518 | - Add `autoDestroy` option to automatically `destroy()` the stream | ||
| 1519 | - when it emits `'finish'` or errors | ||
| 1516 | + description: Add `autoDestroy` option to automatically `destroy()` the | ||
| 1517 | + stream when it emits `'finish'` or errors. | ||
| 1520 | 1518 | --> | |
| 1521 | 1519 | ||
| 1522 | 1520 | * `options` {Object} | |
@@ -1782,9 +1780,8 @@ constructor and implement the `readable._read()` method. | |||
| 1782 | 1780 | changes: | |
| 1783 | 1781 | - version: v11.2.0 | |
| 1784 | 1782 | pr-url: https://github.com/nodejs/node/pull/22795 | |
| 1785 | - description: > | ||
| 1786 | - Add `autoDestroy` option to automatically `destroy()` the stream | ||
| 1787 | - when it emits `'end'` or errors | ||
| 1783 | + description: Add `autoDestroy` option to automatically `destroy()` the | ||
| 1784 | + stream when it emits `'end'` or errors. | ||
| 1788 | 1785 | --> | |
| 1789 | 1786 | ||
| 1790 | 1787 | * `options` {Object} | |
@@ -1848,7 +1845,7 @@ added: v0.9.4 | |||
| 1848 | 1845 | changes: | |
| 1849 | 1846 | - version: v10.0.0 | |
| 1850 | 1847 | pr-url: https://github.com/nodejs/node/pull/17979 | |
| 1851 | - description: call `_read()` only once per microtick | ||
| 1848 | + description: Call `_read()` only once per microtick. | ||
| 1852 | 1849 | --> | |
| 1853 | 1850 | ||
| 1854 | 1851 | * `size` {number} Number of bytes to read asynchronously | |
0 commit comments