Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: wrap and punctuate YAML description text #25419

Closed
wants to merge 1 commit into from
Closed

doc: wrap and punctuate YAML description text #25419

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 9 additions & 12 deletions doc/api/stream.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()`.
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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}
Expand Down Expand Up @@ -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
Expand Down