From 7861793d382aa776214f10c6c3bf61a18720e493 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 "GB" refers to 10**9 bytes, whereas the actual limit is 2**30. The correct unit symbol is "GiB". --- 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 97e848f56fa1fa..aaed461c227b2c 100644 --- a/doc/api/stream.md +++ b/doc/api/stream.md @@ -1126,7 +1126,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