doc: clarify description of readable.push() method

ImHype · Trott · commit 63c0f15a8286 · 2019-09-27T15:36:00.000-07:00
PR-URL: #29687 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Beth Griggs <Bethany.Griggs@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
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

Original file line number	Diff line number	Diff line change
`@@ -2148,8 +2148,8 @@ class SourceWrapper extends Readable {`
`2148`	`2148`	`}`
`2149`	`2149`	```
`2150`	`2150`
`2151`		-The `readable.push()` method is intended be called only by `Readable`
`2152`		-implementers, and only from within the `readable._read()` method.
	`2151`	+The `readable.push()` method is used to push the content
	`2152`	+into the internal buffer. It can be driven by the `readable._read()` method.
`2153`	`2153`
`2154`	`2154`	For streams not operating in object mode, if the `chunk` parameter of
`2155`	`2155`	`readable.push()` is `undefined`, it will be treated as empty string or