Skip to content

Commit 7861793

Browse files
committed
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".
1 parent 6e8701b commit 7861793

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/api/stream.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1126,7 +1126,7 @@ buffer will be returned.
11261126
If the `size` argument is not specified, all of the data contained in the
11271127
internal buffer will be returned.
11281128

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

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

0 commit comments

Comments
 (0)