doc/api: clarify the documentation of pipes and zlib objects in them #22354
Conversation
This file contains 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
Document how pipes can be chained in readable.pipe(). Document that zlib.Zlib inherits from stream.Transform. Fixes: #22341
| @@ -397,6 +397,9 @@ added: v0.5.8 | |||
| Not exported by the `zlib` module. It is documented here because it is the base | |||
| class of the compressor/decompressor classes. | |||
|
|
|||
| This class inherits from [`stream.Transform`][], allowing `zlib` objects to be | |||
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
There was a problem hiding this comment.
Thanks. Reference-style links were new to me.
vsemozhetbyt
added
stream
|
cc @nodejs/zlib @nodejs/streams |
vsemozhetbyt
approved these changes
Aug 16, 2018
This comment has been minimized.
This comment has been minimized.
jasnell
approved these changes
Aug 16, 2018
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
mcollina
reviewed
Aug 16, 2018
doc/api/stream.md
Outdated
| * Returns: {stream.Writable} making it possible to set up chains of piped | ||
| streams | ||
| * Returns: {stream.Writable} The *destination*, allowing for a chain of pipes if | ||
| it is a [`Duplex`][] stream |
There was a problem hiding this comment.
I would add “or a Transform” - a reader might not know that Transform inherits from
Duplex.
lpinca
approved these changes
Aug 16, 2018
BridgeAR
approved these changes
Aug 17, 2018
BridgeAR
added
the
author ready
trivikr
approved these changes
Aug 17, 2018
vsemozhetbyt
added
the
fast-track
|
Landed in 44d04a8 |
vsemozhetbyt
pushed a commit
that referenced
this pull request
Aug 18, 2018
Document how pipes can be chained in readable.pipe(). Document that zlib.Zlib inherits from stream.Transform. PR-URL: #22354 Fixes: #22341 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
targos
pushed a commit
that referenced
this pull request
Aug 19, 2018
Document how pipes can be chained in readable.pipe(). Document that zlib.Zlib inherits from stream.Transform. PR-URL: #22354 Fixes: #22341 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
targos
pushed a commit
that referenced
this pull request
Sep 3, 2018
Document how pipes can be chained in readable.pipe(). Document that zlib.Zlib inherits from stream.Transform. PR-URL: #22354 Fixes: #22341 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This was referenced Sep 6, 2018
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.
I made a first attempt to change the documentation for #22341. I don't know why
stream.Transformdidn't turn into a link inzlib.md. Somebody else would need to fix that if you accept this PR.Checklist