FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: update stream.md by tanujasawant · Pull Request #9468 · nodejs/node · GitHub

/ node Public

doc: update stream.md - #9468

Closed
tanujasawant wants to merge 3 commits into
nodejs:masterfrom
tanujasawant:master
ConversationCommits (3)ChecksFiles changed
Closed

doc: update stream.md#9468
tanujasawant wants to merge 3 commits into
nodejs:masterfrom
tanujasawant:master

Conversation

tanujasawant commented Nov 4, 2016

Copy link
Copy Markdown
Contributor
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

stream.md is updated to explain the return value of
writable.write(chunk) precisely.
Fixes: #9247

doc: update stream.md
97fbcea 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.
Fixes: #9247
nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Nov 4, 2016
sam-github reviewed Nov 4, 2016
View reviewed changes
Comment thread doc/api/stream.md Outdated
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

sam-github Nov 4, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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
View reviewed changes
Comment thread doc/api/stream.md Outdated
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

cjihrig Nov 4, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

false -> false

doc: update stream.md
39c77bb 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.
Fixes: #9247

tanujasawant commented Nov 4, 2016

Copy link
Copy Markdown
Contributor Author

@sam-github @cjihrig please check, thanks for the feedback :)

ronkorving reviewed Nov 7, 2016
View reviewed changes
Comment thread doc/api/stream.md Outdated
`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.

ronkorving Nov 7, 2016

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

suggestion: accept -> accept and buffer

doc: update stream.md
dba0251 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.
Fixes: #9247

tanujasawant commented Nov 8, 2016

Copy link
Copy Markdown
Contributor Author

@ronkorving please check now, thanks!

silverwind commented Nov 18, 2016

Copy link
Copy Markdown
Contributor

ping @ronkorving.

binki suggested changes Nov 25, 2016
View reviewed changes

binki left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

“internal buffer does not exceed highWaterMark” needs to convey the meaning “internal buffer is smaller than highWaterMark”.

ronkorving commented Dec 21, 2016

Copy link
Copy Markdown
Contributor

Apologies, my GitHub notifications are starting to look like my inbox. LGTM!

silverwind commented Dec 21, 2016

Copy link
Copy Markdown
Contributor

Thanks! Landed with wrapping and commit message fixed in f347dad.

silverwind closed this Dec 21, 2016
silverwind pushed a commit that referenced this pull request Dec 21, 2016
doc: update writable.write return value
f347dad 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.

PR-URL: #9468
Fixes: #9247
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: Roman Reiss <me@silverwind.io>
evanlucas mentioned this pull request Jan 3, 2017
Merged
evanlucas pushed a commit that referenced this pull request Jan 3, 2017
doc: update writable.write return value
eff7bc9 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.

PR-URL: #9468
Fixes: #9247
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: Roman Reiss <me@silverwind.io>
evanlucas pushed a commit that referenced this pull request Jan 4, 2017
doc: update writable.write return value
85d2a2a 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.

PR-URL: #9468
Fixes: #9247
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jan 23, 2017
doc: update writable.write return value
ba6a1b6 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.

PR-URL: #9468
Fixes: #9247
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Jan 24, 2017
doc: update writable.write return value
1beb169 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.

PR-URL: #9468
Fixes: #9247
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins mentioned this pull request Jan 24, 2017
Merged
MylesBorins pushed a commit that referenced this pull request Jan 31, 2017
doc: update writable.write return value
b814b4c 
stream.md is updated to explain the return value of
writable.write(chunk) precisely.

PR-URL: #9468
Fixes: #9247
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ron Korving <ron@ronkorving.nl>
Reviewed-By: Roman Reiss <me@silverwind.io>
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

cjihrig cjihrig left review comments
jasnell jasnell approved these changes
+4 more reviewers
sam-github sam-github left review comments
ronkorving ronkorving left review comments
binki binki requested changes
silverwind silverwind approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

streams documentation for writable.write(chunk) describes return value incorrectly

9 participants

Back | FazBrowse Home | New Git URL