doc: make general improvements to Buffer docs #7784
Merged
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
mscdex
added
buffer
|
/cc @nodejs/documentation |
Darn you, GitHub. @mscdex would you mind splitting up in two or more logical commits so we can do inline review? |
mscdex
force-pushed
the
doc-improve-buffer
branch
from
c33ab18
to
977fdef
Compare
|
@silverwind Done. |
|
/cc @nodejs/collaborators |
| [`TypedArray.from()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/from | ||
|
|
||
| [`ArrayBuffer`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer | ||
| [`ArrayBuffer#slice()`]:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/ArrayBuffer/slice |
|
Made it about half way through tonight. Awesome work. |
mscdex
force-pushed
the
doc-improve-buffer
branch
from
977fdef
to
5867219
Compare
|
Woo! LGTM |
| @@ -542,14 +537,13 @@ Note that the `Buffer` module pre-allocates an internal `Buffer` instance of | |||
| size [`Buffer.poolSize`] that is used as a pool for the fast allocation of new | |||
| `Buffer` instances created using [`Buffer.allocUnsafe()`] (and the deprecated | |||
| `new Buffer(size)` constructor) only when `size` is less than or equal to | |||
| `Buffer.poolSize >> 1` (floor of `Buffer.poolSize` divided by two). The default | |||
| value of `Buffer.poolSize` is `8192` but can be modified. | |||
| `Buffer.poolSize >> 1` (floor of [`Buffer.poolSize`] divided by two). | |||
There was a problem hiding this comment.
Do we really want this "floor of ... divided by two" here? Looks like condition doesn't change if we remove it, Buffer.poolSize >> 1 is rather computation optimization than something users should be aware of.
For example, if Buffer.poolSize would be equal to 3, both conditions size is less than or equal to Buffer.poolSize >> 1 (floor of Buffer.poolSize divided by two) (size <= 1) and size is less than or equal to Buffer.poolSize divided by two (size <= 1.5) are equal for any integer size.
Or do we explicitly want to specify behavior for cases when floating number is passed as a size?
|
Thanks for the changes. LGTM |
mscdex
force-pushed
the
doc-improve-buffer
branch
from
5867219
to
8b6d7bd
Compare
PR-URL: nodejs#7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
This commit adds more links and separates internal doc links from external web links. PR-URL: nodejs#7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
This commit adds more links and reuses existing link references more. PR-URL: nodejs#7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
PR-URL: nodejs#7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
mscdex
force-pushed
the
doc-improve-buffer
branch
from
8b6d7bd
to
b3127df
Compare
cjihrig
pushed a commit
that referenced
this pull request
Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig
pushed a commit
that referenced
this pull request
Aug 10, 2016
This commit adds more links and separates internal doc links from external web links. PR-URL: #7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig
pushed a commit
that referenced
this pull request
Aug 10, 2016
This commit adds more links and reuses existing link references more. PR-URL: #7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig
pushed a commit
that referenced
this pull request
Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig
pushed a commit
that referenced
this pull request
Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig
pushed a commit
that referenced
this pull request
Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
cjihrig
pushed a commit
that referenced
this pull request
Aug 10, 2016
PR-URL: #7784 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
Merged
|
@mscdex I'm going to pass on landing this due to it being such a big change, and not being 100% if it aligns to the v4.x implementation of buffer. Please feel free to backport |
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.
Checklist
Affected core subsystem(s)
Description of change