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". PR-URL: #35051 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Gerhard Stöbich <[email protected]>
nodejs · Oct 14, 2020 · 41d7500 · 41d7500
1 parent 00eff4a
commit 41d7500
Showing 1 changed file with 1 addition and 1 deletion.
diff --git 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