doc: fix stream documentation for object mode#11807
Closed
Uh oh!
There was an error while loading. Please reload this page.
Conversation
This file contains hidden or 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
nodejs-github-bot added doc This patch fixes some trivial documentation mistakes for streams operating in object mode. For `unshift()`, `_write()`, `push()` and `_transform()`, the data type of the `chunk` parameter is extended with `any` and the description is corrected to take into account that streams can operate in object mode.
chdh changed the title 
jasnell approved these changes Mar 15, 2017
Member
jasnell left a comment
jasnell left a comment There was a problem hiding this comment.
LGTM but let's hear from @nodejs/streams also
cjihrig approved these changes Mar 15, 2017
fhinkel approved these changes Mar 15, 2017
addaleax approved these changes Mar 15, 2017
jasnell pushed a commit that referenced this pull request Mar 15, 2017
This patch fixes some trivial documentation mistakes for streams operating in object mode. For `unshift()`, `_write()`, `push()` and `_transform()`, the data type of the `chunk` parameter is extended with `any` and the description is corrected to take into account that streams can operate in object mode. PR-URL: #11807 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
Member
jasnell commented Mar 15, 2017
Landed in e296ffb |
italoacasas pushed a commit to italoacasas/node that referenced this pull request Mar 20, 2017
This patch fixes some trivial documentation mistakes for streams operating in object mode. For `unshift()`, `_write()`, `push()` and `_transform()`, the data type of the `chunk` parameter is extended with `any` and the description is corrected to take into account that streams can operate in object mode. PR-URL: nodejs#11807 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017
This patch fixes some trivial documentation mistakes for streams operating in object mode. For `unshift()`, `_write()`, `push()` and `_transform()`, the data type of the `chunk` parameter is extended with `any` and the description is corrected to take into account that streams can operate in object mode. PR-URL: nodejs#11807 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Franziska Hinkelmann <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
Contributor
MylesBorins commented Apr 18, 2017
This does not land cleanly in LTS. Please feel free to manually backport. Please also feel free to replace do-not-land if it is being backported |
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
8 participants
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.
doc: fixes some trivial documentation mistakes for streams operating in object mode
For
unshift(),_write(),push()and_transform(), the data type of thechunkparameter is extended withanyand the documentation is corrected to take into account that streams can operate in object mode.Checklist
Affected core subsystem(s)
documentation