Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit f58b530

Browse filesBrowse files
sam-githubaddaleax
authored andcommitted
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
Copy full SHA for f58b530

File tree

Expand file treeCollapse file tree

1 file changed

+9
-12
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+9
-12
lines changed
Open diff view settings
Collapse file

‎doc/api/stream.md‎

Copy file name to clipboardExpand all lines: doc/api/stream.md
+9-12Lines changed: 9 additions & 12 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -788,9 +788,8 @@ added: v0.9.4
788788
changes:
789789
- version: v10.0.0
790790
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.
794793
- version: v10.0.0
795794
pr-url: https://github.com/nodejs/node/pull/18994
796795
description: Using `'readable'` requires calling `.read()`.
@@ -1510,13 +1509,12 @@ constructor and implement the `writable._write()` method. The
15101509
changes:
15111510
- version: v10.0.0
15121511
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.
15151514
- version: v11.2.0
15161515
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.
15201518
-->
15211519

15221520
* `options` {Object}
@@ -1782,9 +1780,8 @@ constructor and implement the `readable._read()` method.
17821780
changes:
17831781
- version: v11.2.0
17841782
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.
17881785
-->
17891786

17901787
* `options` {Object}
@@ -1848,7 +1845,7 @@ added: v0.9.4
18481845
changes:
18491846
- version: v10.0.0
18501847
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.
18521849
-->
18531850

18541851
* `size` {number} Number of bytes to read asynchronously

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.