doc: fix unit of size argument of readable.read #35051
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
"GB" refers to 10**9 bytes, whereas the actual limit is 2**30. The correct unit symbol is "GiB".
nodejs-github-bot
added
doc
|
I guess this depends on the base used. I think both are acceptable. |
lpinca
approved these changes
Sep 4, 2020
github-actions
bot
removed
the
request-ci
tniessen
added
the
author ready
Trott
reviewed
Sep 6, 2020
| @@ -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. | |||
There was a problem hiding this comment.
Not a blocker, as if anyone has any great ideas, they can always be implemented later, but I think the distinction is esoteric enough that we should spell it out on the first occurrence (or maybe even every occurrence). But I'm also having a hard time figuring out a way to do it in a straightforward way. 1024^3 bytes is not exactly immediately clarifying. (My thought would be, "Isn't that the same as a GB?")
MrHeer
approved these changes
Sep 7, 2020
tniessen
added
the
commit-queue
tniessen
force-pushed
the
doc-be-explicit-about-gib-unit
branch
from
7861793
to
277e12c
Compare
github-actions
bot
removed
the
commit-queue
Commit Queue failed- Loading data for nodejs/node/pull/35051 ✔ Done loading data for nodejs/node/pull/35051 ----------------------------------- PR info ------------------------------------ Title doc: fix unit of size argument of readable.read (#35051) ⚠ Could not retrieve the email or name of the PR author's from user's GitHub profile! Branch tniessen:doc-be-explicit-about-gib-unit -> nodejs:master Labels author ready, doc, stream Commits 1 - doc: fix unit of size argument of readable.read Committers 1 - Tobias Nießen PR-URL: https://github.com/nodejs/node/pull/35051 Reviewed-By: Luigi Pinca Reviewed-By: Matteo Collina ------------------------------ Generated metadata ------------------------------ PR-URL: https://github.com/nodejs/node/pull/35051 Reviewed-By: Luigi Pinca Reviewed-By: Matteo Collina -------------------------------------------------------------------------------- ⚠ Commits were pushed since the last review: ⚠ - doc: fix unit of size argument of readable.read ✖ GitHub CI is still running ℹ Doc-only changes ℹ This PR was created on Fri, 04 Sep 2020 09:55:48 GMT ✔ Approvals: 2 ✔ - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/35051#pullrequestreview-482573171 ✔ - Matteo Collina (@mcollina) (TSC): https://github.com/nodejs/node/pull/35051#pullrequestreview-482739095 -------------------------------------------------------------------------------- ✔ Aborted `git node land` session in /home/runner/work/node/node/.ncu |
github-actions
bot
added
the
commit-queue-failed
tniessen
removed
the
commit-queue-failed
tniessen
force-pushed
the
doc-be-explicit-about-gib-unit
branch
from
277e12c
to
7861793
Compare
aduh95
approved these changes
Oct 11, 2020
aduh95
added
the
commit-queue
Flarna
added
request-ci
github-actions
bot
removed
the
request-ci
Flarna
approved these changes
Oct 13, 2020
Flarna
added
the
commit-queue
github-actions
bot
removed
the
commit-queue
|
Landed in 2cfdf28...d7e5d65 |
nodejs-github-bot
pushed a commit
that referenced
this pull request
Oct 13, 2020
"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 <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
MylesBorins
pushed a commit
that referenced
this pull request
Oct 14, 2020
"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 <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Merged
joesepi
pushed a commit
to joesepi/node
that referenced
this pull request
Jan 8, 2021
"GB" refers to 10**9 bytes, whereas the actual limit is 2**30. The correct unit symbol is "GiB". PR-URL: nodejs#35051 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
tniessen
removed
the
author ready
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In the context of data transmission, "GB" refers to 109 bytes, whereas the actual limit is 230. The correct unit symbol is "GiB".
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes