Skip to content

doc: improve doc writable streams: 'finish' event#30889

Closed
dev-script wants to merge 1 commit intonodejs:masterfrom
dev-script:doc/stream-finish-event
Closed

doc: improve doc writable streams: 'finish' event#30889
dev-script wants to merge 1 commit intonodejs:masterfrom
dev-script:doc/stream-finish-event

Conversation

@dev-script
Copy link
Contributor

@dev-script dev-script commented Dec 10, 2019 •
edited
Loading

doc change for stream.md that 'finish' event should be before
writer.end

fixes: #30759

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

@dev-script
doc: improve doc writable streams: 'finish' event
eda7eb0 
doc change for stream.md that 'finish' event should be before
writer.end

fixes: #30759
@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 Dec 10, 2019
@dev-script
Copy link
Contributor Author

dev-script commented Dec 10, 2019

@GrosSacASac please review.

@ronag
Copy link
Member

ronag commented Dec 10, 2019 •
edited
Loading

I'm not sure I understand the purpose here? 'finish' should be emitted in the next tick so the order there shouldn't matter. Is this to make it easier to understand?

@GrosSacASac
Copy link
Contributor

GrosSacASac commented Dec 11, 2019

Yes to make it easier to understand and also to make it easier to switch to implementation that don't rely on this hidden gimmick.

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Dec 13, 2019
@Trott
Copy link
Member

Trott commented Dec 13, 2019

Landed in 08728a1

@Trott Trott closed this Dec 13, 2019
Trott pushed a commit that referenced this pull request Dec 13, 2019
@dev-script @Trott
doc: improve doc writable streams: 'finish' event
08728a1 
doc change for stream.md that 'finish' event should be before
writer.end

fixes: #30759

PR-URL: #30889
Fixes: #30759
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 17, 2019
@dev-script @MylesBorins
doc: improve doc writable streams: 'finish' event
b53e2a8 
doc change for stream.md that 'finish' event should be before
writer.end

fixes: #30759

PR-URL: #30889
Fixes: #30759
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Dec 17, 2019
Merged
targos pushed a commit that referenced this pull request Jan 14, 2020
@dev-script @targos
doc: improve doc writable streams: 'finish' event
690deaa 
doc change for stream.md that 'finish' event should be before
writer.end

fixes: #30759

PR-URL: #30889
Fixes: #30759
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@targos targos mentioned this pull request Jan 15, 2020
Closed
BethGriggs pushed a commit that referenced this pull request Feb 6, 2020
@dev-script @BethGriggs
doc: improve doc writable streams: 'finish' event
be4fffe 
doc change for stream.md that 'finish' event should be before
writer.end

fixes: #30759

PR-URL: #30889
Fixes: #30759
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Feb 8, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Trott Trott Trott approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

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.

Documentation writable stream example confusing order

6 participants

@dev-script @ronag @GrosSacASac @Trott @BridgeAR @nodejs-github-bot