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: fix Writable.write callback description #31812

Closed
wants to merge 3 commits into from
Closed

doc: fix Writable.write callback description #31812

wants to merge 3 commits into from

Conversation

ronag
Copy link
Member

@ronag ronag commented Feb 15, 2020

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 ronag added the stream Issues and PRs related to the stream subsystem. label Feb 15, 2020
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Feb 15, 2020
@ronag
Copy link
Member Author

ronag commented Feb 15, 2020

@nodejs/streams

@ronag
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 ronag force-pushed the stream-doc-writable-callback branch from 0cf3ff7 to 8c19c23 Compare February 15, 2020 13:17
@lpinca
Copy link
Member

lpinca commented Feb 15, 2020

I think this depends on #31317.

@ronag
Copy link
Member Author

ronag commented Feb 15, 2020 •
edited
Loading

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
Copy link
Member

lpinca commented Feb 15, 2020 •
edited
Loading

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
Copy link
Member Author

ronag commented Feb 15, 2020 •
edited
Loading

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
lpinca reviewed Feb 15, 2020
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
@ronag @lpinca
Update doc/api/stream.md
c17d261 
Co-Authored-By: Luigi Pinca <[email protected]>
mcollina
mcollina approved these changes Feb 15, 2020
View reviewed changes
Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@ronag ronag added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 16, 2020
@ronag ronag requested a review from lpinca February 16, 2020 14:05
lpinca
lpinca approved these changes Feb 16, 2020
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
@ronag @lpinca
Update doc/api/stream.md
ff707a5 
Co-Authored-By: Luigi Pinca <[email protected]>
@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

@nodejs-github-bot
Copy link
Collaborator

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

ronag added a commit that referenced this pull request Feb 18, 2020
@ronag
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 <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@ronag
Copy link
Member Author

ronag commented Feb 18, 2020

Landed in 7c524fb

@ronag ronag closed this Feb 18, 2020
@MylesBorins
Copy link
Contributor

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

@lpinca
Copy link
Member

lpinca commented Mar 6, 2020

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

@lpinca
Copy link
Member

lpinca commented Mar 6, 2020

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

@lpinca lpinca mentioned this pull request Mar 6, 2020
Closed
3 tasks
@BethGriggs BethGriggs mentioned this pull request Apr 14, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

@mcollina mcollina mcollina approved these changes

@addaleax addaleax Awaiting requested review from addaleax

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, 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
@ronag @lpinca @nodejs-github-bot @MylesBorins @mcollina @jasnell