From 683bc61d2ef68dcba34c04f834c3588585ef107d Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Fri, 14 Jan 2022 09:42:38 -0800 Subject: [PATCH] doc: add missing word in readable.read() text MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This adds a missing _is_ in the readable.read() text and makes small style adjustments. PR-URL: https://github.com/nodejs/node/pull/41524 Reviewed-By: Richard Lau Reviewed-By: Tobias Nießen Reviewed-By: Antoine du Hamel Reviewed-By: Darshan Sen Reviewed-By: Benjamin Gruenbaum --- doc/api/stream.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index 1f7f679e3ba5a4..e2bded5c62a3eb 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1256,9 +1256,9 @@ added: v0.9.4 * `size` {number} Optional argument to specify how much data to read. * Returns: {string|Buffer|null|any} -The `readable.read()` method pulls some data out of the internal buffer and -returns it. If no data available to be read, `null` is returned. By default, -the data will be returned as a `Buffer` object unless an encoding has been +The `readable.read()` method reads data out of the internal buffer and +returns it. If no data is available to be read, `null` is returned. By default, +the data is returned as a `Buffer` object unless an encoding has been specified using the `readable.setEncoding()` method or the stream is operating in object mode.