Skip to content

doc: make suggestion more direct in stream.md #19124

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

doc: make suggestion more direct in stream.md #19124

wants to merge 1 commit into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Mar 4, 2018

Checklist
Affected core subsystem(s)

doc

@Trott Trott added the doc Issues and PRs related to the documentations. label Mar 4, 2018
@nodejs-github-bot nodejs-github-bot added the stream Issues and PRs related to the stream subsystem. label Mar 4, 2018
@Trott
Copy link
Member Author

Trott commented Mar 4, 2018

Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite/206/

@mscdex
Copy link
Contributor

mscdex commented Mar 4, 2018 •
edited
Loading

I think it would be better to explain why, because stream.read(n) is certainly a useful feature to have.

gibfahn
gibfahn reviewed Mar 4, 2018
View reviewed changes
Copy link
Member

@gibfahn gibfahn left a comment

Choose a reason for hiding this comment

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

LGTM, but +1 to @mscdex 's suggestion.

@Trott
Copy link
Member Author

Trott commented Mar 4, 2018

I think it would be better to explain why

Suggested text, anyone?

@gibfahn
Copy link
Member

gibfahn commented Mar 5, 2018

Suggested text, anyone?

Yeah that's why it was a non-blocking suggestion (from me at least) 😁 .

@mscdex
Copy link
Contributor

mscdex commented Mar 5, 2018 •
edited
Loading

The text seems to have been added by @jasnell in #6947. Quickly browsing that PR's reviews, it seems @chrisdickinson may have implicitly suggested its inclusion, although no reasoning was given behind the sentiment there either.

I think either the comment should be removed entirely or perhaps a reduced version of the comment should be used instead, one that promotes the use of pipe() (where possible) over manual 'data' event handlers or manual .read() invocations.

@Trott
Copy link
Member Author

Trott commented Mar 7, 2018

Landed in cb5f9a6.

Will follow up on @mscdex's suggestion in a subsequent pull request.

@Trott Trott closed this Mar 7, 2018
Trott added a commit that referenced this pull request Mar 7, 2018
@Trott
doc: make suggestion more direct in stream.md
cb5f9a6 
PR-URL: #19124
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos pushed a commit that referenced this pull request Mar 17, 2018
@Trott @targos
doc: make suggestion more direct in stream.md
187d5f2 
PR-URL: #19124
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@targos targos mentioned this pull request Mar 18, 2018
Merged
MylesBorins pushed a commit that referenced this pull request Mar 20, 2018
@Trott @MylesBorins
doc: make suggestion more direct in stream.md
9ec0eab 
PR-URL: #19124
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@Trott @MayaLekova
doc: make suggestion more direct in stream.md
33323a3 
PR-URL: nodejs#19124
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
jasnell pushed a commit to jasnell/node that referenced this pull request Aug 17, 2018
@Trott @jasnell
doc: make suggestion more direct in stream.md
2bb3600 
PR-URL: nodejs#19124
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
MylesBorins pushed a commit that referenced this pull request Sep 6, 2018
@Trott @MylesBorins
doc: make suggestion more direct in stream.md
1116d32 
Backport-PR-URL: #22380
PR-URL: #19124
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
@MylesBorins MylesBorins mentioned this pull request Sep 6, 2018
Merged
@Trott Trott deleted the in-general-1 branch January 13, 2022 22:48
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@gibfahn gibfahn gibfahn left review comments

@jasnell jasnell jasnell approved these changes

@cjihrig cjihrig cjihrig approved these changes

@BridgeAR BridgeAR BridgeAR approved these changes

Assignees
No one assigned
Labels
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.
7 participants
@Trott @mscdex @gibfahn @jasnell @cjihrig @BridgeAR @nodejs-github-bot