Skip to content

doc: fix 'close' event descriptions for fs.ReadStream and fs.WriteStream #15790

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

Closed
JamesMGreene wants to merge 1 commit into from
Closed

doc: fix 'close' event descriptions for fs.ReadStream and fs.WriteStream #15790

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/api/fs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,8 @@ added: v0.1.93

* `fd` {integer} Integer file descriptor used by the ReadStream.

Emitted when the ReadStream's file is opened.
Emitted when the `ReadStream`'s underlying file descriptor has been closed
using the `fs.close()` method.
Copy link
Contributor

@mscdex mscdex Oct 6, 2017

Choose a reason for hiding this comment

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

I think this last part can/should be omitted. Just end on 'has been closed.'

Copy link
Contributor Author

@JamesMGreene JamesMGreene Oct 6, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

I fully agree but I copied that markdown verbatim from the v4.x and v8.x docs. As such, I'd suggest either changing it here but also in those spots (or at least v8.x) as well, or else leaving it intact here.

But yeah, that last bit seems unnecessary and, honestly, a bit awkward.

Copy link
Contributor Author

@JamesMGreene JamesMGreene Oct 6, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

How is the upstreaming of commits to other version branches typically handled for this repo? For example, if I changed it here in v6.x, would I submit separate PRs for all of the v7.x, v8.x, v9.x, and master branches, or do changes to some of them get upstream/merged into others?

Copy link
Contributor

@mscdex mscdex Oct 6, 2017

Choose a reason for hiding this comment

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

Make the change in master and it will be backported at some point.

Copy link
Contributor Author

@JamesMGreene JamesMGreene Oct 6, 2017 •
edited
Loading

Choose a reason for hiding this comment

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

@mscdex How far do you backport? Should I rebase this PR to be targeting master instead of directly to v6.x, or this PR plus another PR targeting master?

Copy link
Contributor

@mscdex mscdex Oct 6, 2017

Choose a reason for hiding this comment

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

Well this particular change was made in other branches inadvertently(?) in #11331 it seems. So this PR is fine for now for consistency.

If you want to submit another PR to remove the last portion of this sentence, you'd file a PR against master and it will automatically trickle down to the versioned branches by releasers.

Copy link
Contributor Author

@JamesMGreene JamesMGreene Oct 6, 2017

Choose a reason for hiding this comment

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

Sounds good. 👍

Copy link
Contributor Author

@JamesMGreene JamesMGreene Oct 6, 2017

Choose a reason for hiding this comment

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

Followup work submitted as PR #15800.


### readStream.bytesRead
<!-- YAML
Expand Down Expand Up @@ -296,7 +297,8 @@ added: v0.1.93

* `fd` {integer} Integer file descriptor used by the WriteStream.

Emitted when the WriteStream's file is opened.
Emitted when the `WriteStream`'s underlying file descriptor has been closed
using the `fs.close()` method.
Copy link
Contributor

@mscdex mscdex Oct 6, 2017

Choose a reason for hiding this comment

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

Ditto.


### writeStream.bytesWritten
<!-- YAML
Expand Down