doc: update stream.md #9468
Closed
doc: update stream.md #9468
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stream.md is updated to explain the return value of writable.write(chunk) precisely. Fixes: #9247
nodejs-github-bot
added
doc
sam-github
reviewed
Nov 4, 2016
| The return value is `true` if the internal buffer does not exceed | ||
| `highWaterMark` configured when the stream was created after admitting | ||
| `chunk`. If false is returned, further attempts to write data to the stream | ||
| should be paused until the [`'drain'`][] event is emitted. However, the |
There was a problem hiding this comment.
suggest: "should be paused" -> "should stop"
I find the use of the word paused confusing, because there is a stream.pause() method, but calling it is not the "paused" referred to in the documentation.
cjihrig
reviewed
Nov 4, 2016
| should be paused until the [`'drain'`][] event is emitted. | ||
| The return value is `true` if the internal buffer does not exceed | ||
| `highWaterMark` configured when the stream was created after admitting | ||
| `chunk`. If false is returned, further attempts to write data to the stream |
stream.md is updated to explain the return value of writable.write(chunk) precisely. Fixes: #9247
|
@sam-github @cjihrig please check, thanks for the feedback :) |
jasnell
approved these changes
Nov 6, 2016
ronkorving
reviewed
Nov 7, 2016
| `chunk`. If `false` is returned, further attempts to write data to the stream | ||
| should stop until the [`'drain'`][] event is emitted. However, the | ||
| `false` return value is only advisory and the writable stream will | ||
| unconditionally accept `chunk` even if it has not not been allowed to drain. |
There was a problem hiding this comment.
suggestion: accept -> accept and buffer
stream.md is updated to explain the return value of writable.write(chunk) precisely. Fixes: #9247
|
@ronkorving please check now, thanks! |
|
ping @ronkorving. |
binki
suggested changes
Nov 25, 2016
|
Apologies, my GitHub notifications are starting to look like my inbox. LGTM! |
silverwind
approved these changes
Dec 21, 2016
|
Thanks! Landed with wrapping and commit message fixed in f347dad. |
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
Affected core subsystem(s)
doc
Description of change
stream.md is updated to explain the return value of
writable.write(chunk) precisely.
Fixes: #9247