doc: clarify description of readable.push() method

PR-URL: #29687 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · Sep 27, 2019 · 63c0f15 · 63c0f15
1 parent 7223ce2
commit 63c0f15
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/doc/api/stream.md b/doc/api/stream.md
@@ -2148,8 +2148,8 @@ class SourceWrapper extends Readable {
 }
 ```
 
-The `readable.push()` method is intended be called only by `Readable`
-implementers, and only from within the `readable._read()` method.
+The `readable.push()` method is used to push the content
+into the internal buffer. It can be driven by the `readable._read()` method.
 
 For streams not operating in object mode, if the `chunk` parameter of
 `readable.push()` is `undefined`, it will be treated as empty string or