Skip to content

Commit 41d7500

Browse files
tniessenMylesBorins
authored andcommitted
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]>
1 parent 00eff4a commit 41d7500

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/api/stream.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1127,7 +1127,7 @@ buffer will be returned.
11271127
If the `size` argument is not specified, all of the data contained in the
11281128
internal buffer will be returned.
11291129

1130-
The `size` argument must be less than or equal to 1 GB.
1130+
The `size` argument must be less than or equal to 1 GiB.
11311131

11321132
The `readable.read()` method should only be called on `Readable` streams
11331133
operating in paused mode. In flowing mode, `readable.read()` is called

0 commit comments

Comments
 (0)