doc: Update emitClose default for fs streams - #36653
Merged
Trott merged 1 commit intoJan 2, 2021
Merged
Conversation
Copy link
Copy Markdown
Contributor
Sorry, something went wrong.
Trott
approved these changes
Dec 28, 2020
ronag
requested changes
Dec 28, 2020
ronag
left a comment
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
I think it's better to just remove any mention of emitClose from the fs docs.
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
Author
I agree with that sentiment, but I'm concerned that removing it from the docs would make existing code harder to understand, especially while supported versions still use emitClose: false by default. I actually discovered this issue while checking the docs to understand why emitClose: true was being added to options in a call to fs.createWriteStream. If it had been removed, understanding would have been more difficult. |
Sorry, something went wrong.
ronag
approved these changes
Dec 28, 2020
The default for the `emitClose` option was changed from `false` to `true` by nodejs#31408 which landed in f0d2df4 for v14.0.0. This commit updates the fs doc to match the current behavior. Signed-off-by: Kevin Locke <kevin@kevinlocke.name> PR-URL: nodejs#36653 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
Trott
force-pushed
the
for-upstream/fs-emitClose-docs
branch
from
19ca07b to
d548f4d
Compare
January 2, 2021 18:10
danielleadams
pushed a commit
that referenced
this pull request
Jan 12, 2021
The default for the `emitClose` option was changed from `false` to `true` by #31408 which landed in f0d2df4 for v14.0.0. This commit updates the fs doc to match the current behavior. Signed-off-by: Kevin Locke <kevin@kevinlocke.name> PR-URL: #36653 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
Merged
targos
pushed a commit
that referenced
this pull request
Aug 8, 2021
The default for the `emitClose` option was changed from `false` to `true` by #31408 which landed in f0d2df4 for v14.0.0. This commit updates the fs doc to match the current behavior. Signed-off-by: Kevin Locke <kevin@kevinlocke.name> PR-URL: #36653 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
BethGriggs
pushed a commit
that referenced
this pull request
Aug 12, 2021
The default for the `emitClose` option was changed from `false` to `true` by #31408 which landed in f0d2df4 for v14.0.0. This commit updates the fs doc to match the current behavior. Signed-off-by: Kevin Locke <kevin@kevinlocke.name> PR-URL: #36653 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
MylesBorins
pushed a commit
that referenced
this pull request
Aug 31, 2021
The default for the `emitClose` option was changed from `false` to `true` by #31408 which landed in f0d2df4 for v14.0.0. This commit updates the fs doc to match the current behavior. Signed-off-by: Kevin Locke <kevin@kevinlocke.name> PR-URL: #36653 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Robert Nagy <ronagy@icloud.com>
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
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.
The default for the emitClose option was changed from false to true by #31408 which landed in f0d2df4 for v14.0.0. This commit updates the fs doc to match the current behavior.
Thanks for considering,
Kevin
Checklist