doc: note that buf.buffer's contents might differ #29651
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
nodejs-github-bot
added
buffer
This bit me in a personal project since I had no reason to read the `buf.byteOffset` docs, so point readers there explicitly.
trivikr
reviewed
Sep 22, 2019
| @@ -1025,6 +1025,9 @@ console.log(buf.toString('ascii')); | |||
| * {ArrayBuffer} The underlying `ArrayBuffer` object based on | |||
| which this `Buffer` object is created. | |||
|
|
|||
| This `ArrayBuffer` is not guaranteed to correspond exactly to the original | |||
| `Buffer`. See the notes on `buf.byteOffset` for details. | |||
There was a problem hiding this comment.
Suggested change
| `Buffer`. See the notes on `buf.byteOffset` for details. | |
| `Buffer`. See the notes on [`buf.byteOffset`][] for details. |
Add the following at the bottom:
[`buf.byteOffset`]: #buffer_buf_byteoffset
There was a problem hiding this comment.
I think a better approach is to say that the Buffer is a view over a subset of the ArrayBuffer. It will correspond to that subset only starting at the byteOffset.
|
@nodejs/buffer @nodejs/documentation |
|
This seems to have stalled, so I'm going to close it. If you plan on working revising this to get it landed, please re-open or leave a comment. Thanks! |
|
Actually, I take it back. Re-opening.... |
addaleax
approved these changes
Nov 30, 2019
addaleax
pushed a commit
that referenced
this pull request
Nov 30, 2019
This bit me in a personal project since I had no reason to read the `buf.byteOffset` docs, so point readers there explicitly. PR-URL: #29651 Reviewed-By: Anna Henningsen <anna@addaleax.net>
|
Landed in 5833cfd |
addaleax
pushed a commit
that referenced
this pull request
Nov 30, 2019
This bit me in a personal project since I had no reason to read the `buf.byteOffset` docs, so point readers there explicitly. PR-URL: #29651 Reviewed-By: Anna Henningsen <anna@addaleax.net>
Merged
targos
pushed a commit
that referenced
this pull request
Dec 5, 2019
This bit me in a personal project since I had no reason to read the `buf.byteOffset` docs, so point readers there explicitly. PR-URL: #29651 Reviewed-By: Anna Henningsen <anna@addaleax.net>
Closed
MylesBorins
pushed a commit
that referenced
this pull request
Dec 17, 2019
This bit me in a personal project since I had no reason to read the `buf.byteOffset` docs, so point readers there explicitly. PR-URL: #29651 Reviewed-By: Anna Henningsen <anna@addaleax.net>
Merged
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.
This bit me in a personal project since I had no reason to read the
buf.byteOffsetdocs, so point readers there explicitly.Checklist
- [ ]make -j4 test(UNIX), orvcbuild test(Windows) passes- [ ] tests and/or benchmarks are included