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

doc: fix Writable.write callback description by ronag · Pull Request #31812 · nodejs/node · GitHub

/ node Public

doc: fix Writable.write callback description - #31812

Closed
ronag wants to merge 3 commits into
nodejs:masterfrom
nxtedition:stream-doc-writable-callback
ConversationCommits (3)ChecksFiles changed
Closed

doc: fix Writable.write callback description#31812
ronag wants to merge 3 commits into
nodejs:masterfrom
nxtedition:stream-doc-writable-callback

Conversation

ronag commented Feb 15, 2020

Copy link
Copy Markdown
Member

Clarifies a userland invariant until a better
solution can be found.

Also moves a misplaced sentence from _write to
write.

Refs: #31756
Refs: #31765

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

ronag added the stream Issues and PRs related to the stream subsystem. label Feb 15, 2020
nodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 15, 2020

ronag commented Feb 15, 2020

Copy link
Copy Markdown
Member Author

@nodejs/streams

doc: fix Writable.write callback description
8c19c23 
Clarifies a userland invariant until a better
solution can be found.

Also moves a misplaced sentence from _write to
write.

Refs: nodejs#31756
Refs: nodejs#31765
ronag force-pushed the stream-doc-writable-callback branch from 0cf3ff7 to 8c19c23 Compare February 15, 2020 13:17

lpinca commented Feb 15, 2020

Copy link
Copy Markdown
Member

I think this depends on #31317.

ronag commented Feb 15, 2020 •
edited
Loading

Copy link
Copy Markdown
Member Author

I think this depends on #31317.

How so? This is a timing issue related to when and how the _write callback is invoked by the user.

lpinca commented Feb 15, 2020 •
edited
Loading

Copy link
Copy Markdown
Member

The callback method will always be called asynchronously

Perhaps I'm misunderstanding this? Note "always". Or does that mean that if the callback is called it will be called asynchronously?

ronag commented Feb 15, 2020 •
edited
Loading

Copy link
Copy Markdown
Member Author

Perhaps I'm misunderstanding this? Note "always". Or does that mean that if the callback is called it will be called asynchronously?

Ah now I see what you mean. That part was incorrectly written at _write() instead of write(). I just moved it to where it was intended. That was not the primary purpose of this PR.

And yes the "always" is a bit ambigious but I think the intention is that "is called it will be called asynchronously". Maybe removing "always" would amke it clearer?

lpinca reviewed Feb 15, 2020
View reviewed changes
Comment thread doc/api/stream.md Outdated
Update doc/api/stream.md
c17d261 
Co-Authored-By: Luigi Pinca <luigipinca@gmail.com>
mcollina approved these changes Feb 15, 2020
View reviewed changes

mcollina left a comment

Copy link
Copy Markdown
Member

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

lgtm

ronag added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Feb 16, 2020
ronag requested a review from lpinca February 16, 2020 14:05
lpinca approved these changes Feb 16, 2020
View reviewed changes
Comment thread doc/api/stream.md Outdated
Update doc/api/stream.md
ff707a5 
Co-Authored-By: Luigi Pinca <luigipinca@gmail.com>

nodejs-github-bot commented Feb 17, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/29175/

nodejs-github-bot commented Feb 17, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/29180/

nodejs-github-bot commented Feb 18, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/29219/

nodejs-github-bot commented Feb 18, 2020

Copy link
Copy Markdown
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/29221/

ronag added a commit that referenced this pull request Feb 18, 2020
doc: fix Writable.write callback description
7c524fb 
Clarifies a userland invariant until a better
solution can be found.

Also moves a misplaced sentence from _write to
write.

Refs: #31756
Refs: #31765

PR-URL: #31812
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>

ronag commented Feb 18, 2020

Copy link
Copy Markdown
Member Author

Landed in 7c524fb

ronag closed this Feb 18, 2020

MylesBorins commented Mar 4, 2020

Copy link
Copy Markdown
Contributor

This does not land cleanly on v13.x. Could you please open a backport PR if it should land on that branch

lpinca commented Mar 6, 2020

Copy link
Copy Markdown
Member

I think 75b30c6 must be backported first. Then this will land cleanly.

lpinca commented Mar 6, 2020

Copy link
Copy Markdown
Member

75b30c6 is semver-major, so this should not be backported.

lpinca mentioned this pull request Mar 6, 2020
Closed
3 tasks
BethGriggs mentioned this pull request Apr 14, 2020
Merged
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

mcollina mcollina approved these changes
jasnell jasnell approved these changes
lpinca lpinca approved these changes
addaleax Awaiting requested review from addaleax

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. 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.

6 participants

Back | FazBrowse Home | New Git URL