doc: fix 'close' event descriptions for fs.ReadStream and fs.WriteStream #15790
Conversation
nodejs-github-bot
added
doc
| @@ -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. | |||
There was a problem hiding this comment.
I think this last part can/should be omitted. Just end on 'has been closed.'
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
Make the change in master and it will be backported at some point.
There was a problem hiding this comment.
@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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Followup work submitted as PR #15800.
| @@ -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. | |||
|
IIUC this has been superseded by #15800. Closing. |
|
@joyeecheung: Only if someone makes sure that #15800 makes its way into the |
|
@JamesMGreene Usually people who do releases would take care of that, when there are conflicts they will ping you in the against-master PR about it and ask you to do a manual backport. If it cherry-picks into the release branch cleanly, it will just land. See How to Backport a Pull Request to a Release Line for details. |
|
landed in v6.x-staging in 31e4f2b |
|
Thanks for that, @MylesBorins! |
Checklist
Affected core subsystem(s)
doc
I tried to follow the commit message guidelines but I couldn't think any of good message that was 50 characters or less. If anyone has recommendations, I'd be happy to update it.
Situation: These changes seem to already be in place within the docs for
4.xand8.xbut are somehow missing from6.x. Seemed like an easy but necessary fix when I happened upon it in the docs the other day. 👍