From 41d7500bf946f18ef8478597101c36867f21d42a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tobias=20Nie=C3=9Fen?= Date: Fri, 4 Sep 2020 11:53:16 +0200 Subject: [PATCH] doc: fix unit of size argument of readable.read MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit "GB" refers to 10**9 bytes, whereas the actual limit is 2**30. The correct unit symbol is "GiB". PR-URL: https://github.com/nodejs/node/pull/35051 Reviewed-By: Luigi Pinca Reviewed-By: Matteo Collina Reviewed-By: Antoine du Hamel Reviewed-By: Gerhard Stöbich --- doc/api/stream.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/stream.md b/doc/api/stream.md index d4b05610295e0f..eed68fcc54ea31 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1127,7 +1127,7 @@ buffer will be returned. If the `size` argument is not specified, all of the data contained in the internal buffer will be returned. -The `size` argument must be less than or equal to 1 GB. +The `size` argument must be less than or equal to 1 GiB. The `readable.read()` method should only be called on `Readable` streams operating in paused mode. In flowing mode, `readable.read()` is called