Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

Contradiction in Readable docs #29680

Closed
reergymerej opened this issue Sep 23, 2019 · 2 comments
Closed

Contradiction in Readable docs #29680

reergymerej opened this issue Sep 23, 2019 · 2 comments
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.

Comments

@reergymerej
Copy link

The readable.push() method is intended be called only by Readable implementers, and only from within the readable._read() method.

This immediately follows an example showing

if (!this.push(chunk))
        this._source.readStop();

in the constructor instead.

@Trott Trott added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Sep 24, 2019
@ImHype
Copy link
Contributor

ImHype commented Sep 24, 2019

Could we add some suggested descriptions to the document?

@lpinca
Copy link
Member

lpinca commented Sep 28, 2019

Fixed by #29687.

@lpinca lpinca closed this as completed Sep 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

No branches or pull requests

4 participants