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.

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

docs: end(cb) cb can be invoked with error #32238

Closed
wants to merge 7 commits into from

Conversation

rexagod
Copy link
Member

@rexagod rexagod commented Mar 12, 2020

update docs that the optional callback passed to
writable.end can be invoked in case of an error as well

fixes: #31220

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

update docs that the optional callback passed to
`writable.end` can be invoked in case of an error as well

fixes: nodejs#31220
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Mar 12, 2020
doc/api/stream.md Outdated Show resolved Hide resolved
Copy link
Member

@lpinca lpinca left a comment

Choose a reason for hiding this comment

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

I think we should also add an entry in the changes: array of the YAML metadata.

@rexagod
Copy link
Member Author

rexagod commented Mar 14, 2020

@lpinca Sorry, I don't know what you meant by that. Could you explain that a bit? Thanks!

doc/api/stream.md Outdated Show resolved Hide resolved
@lpinca
Copy link
Member

lpinca commented Mar 15, 2020

@rexagod see line 408-410. I mean an entry like that.

doc/api/stream.md Outdated Show resolved Hide resolved
@rexagod rexagod requested a review from addaleax March 29, 2020 20:12
doc/api/stream.md Outdated Show resolved Hide resolved
Co-Authored-By: Anna Henningsen <[email protected]>
@addaleax addaleax added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 29, 2020
addaleax pushed a commit that referenced this pull request Mar 30, 2020
Update docs that the optional callback passed to
`writable.end` can be invoked in case of an error as well.

PR-URL: #32238
Fixes: #31220
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
@addaleax
Copy link
Member

Landed in 6ade42b

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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
Development

Successfully merging this pull request may close these issues.

docs: end(cb) cb can be invoked with error
6 participants