Skip to content
This repository has been archived by the owner on Apr 22, 2023. It is now read-only.

Minor clarifications around Readable._read and Readable.push #25581

Closed
wants to merge 1 commit into from

Conversation

fresheneesz
Copy link

The `Readable` class works by putting data into a read queue to be
pulled out later by calling the `read()` method when the `'readable'`
event fires.
If a String or Buffer is passed, The `push()` method adds a chunk of data

Choose a reason for hiding this comment

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

This gets a little into the weeds, but this should be "if a non-null value is passed, the push() method adds it into the queue for subsequent..." (taking into account objectMode.)

@fresheneesz
Copy link
Author

Changed the wording as per chris dickinson's comment

@jasnell
Copy link
Member

jasnell commented Jun 26, 2015

Looks like a good change overall. Would appreciate if you could squash the commits down into a single commit and add a bit more of a summary to the commit message (helpful but not critical). Thank you!

@fresheneesz
Copy link
Author

@jasnell Is there an easy way to do that in github or do I have to pull the whole repo?

@fresheneesz
Copy link
Author

Ugh, what an unintuitive process. Ok I squashed the commits into this one: fresheneesz@b2d15f3 . What do I do now? Close this one and create a new pull request?

@jasnell
Copy link
Member

jasnell commented Jun 26, 2015

Nope! Nothing further is necessary on your part. I'll take another pass at reviewing this shortly then will work on getting it landed (likely next week). Thank you!

@fresheneesz
Copy link
Author

Ok! Sure thing!

@jasnell
Copy link
Member

jasnell commented Jul 1, 2015

LGTM. @chrisdickinson @trevnorris

@trevnorris
Copy link

LGTM

@jasnell
Copy link
Member

jasnell commented Aug 4, 2015

@fresheneesz ... unfortunately, this appears to have been clobbered a bit by another change that was landed. If you'd like to rebase and resolve the conflict, that would be great. I'll get it landed right after. Otherwise, once I'm through a few other items I'll see if I can get to rebasing this.

@fresheneesz
Copy link
Author

: / , I don't have time right now to figure that out, but maybe in a couple weeks.

@jasnell
Copy link
Member

jasnell commented Aug 4, 2015

No worries, if I get the time before then I'll untangle it and point here with the new commit.

@jasnell
Copy link
Member

jasnell commented Aug 6, 2015

Ok landed this in 4952e2b and over in io.js as well.

@jasnell jasnell closed this Aug 6, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants