doc: fix doc for napi_get_typedarray_info #20747
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
doc
The data pointer returned for the typedarray has already been adjusted by the offset so it does not point to the start of the buffer, instead id points to the start of the first element. I think we probably would have liked it to point to the start of the buffer, but we can't change as that would be a breaking change. Update the doc to match the implementation. Fixes: nodejs/node-addon-api#244
doc/api/n-api.md
Outdated
| @@ -1750,10 +1750,15 @@ napi_status napi_get_typedarray_info(napi_env env, | |||
| properties to query. | |||
| - `[out] type`: Scalar datatype of the elements within the `TypedArray`. | |||
| - `[out] length`: The number of elements in the `TypedArray`. | |||
| - `[out] data`: The data buffer underlying the `TypedArray`. | |||
| - `[out] data`: The data buffer underlying the `TypedArray` adjusted by | |||
| the byte_offset value so that it points to the first element in the | |||
There was a problem hiding this comment.
byte_offset -> `byte_offset`?
doc/api/n-api.md
Outdated
| at which the first element of the arrays is located. The value for the data | ||
| parameter has already been adjusted so that data points to the first element | ||
| in the array. Therefore, the first byte of the native array would be at | ||
| data - byte_offset. |
There was a problem hiding this comment.
data - byte_offset -> `data - byte_offset`?
gabrielschulhof
approved these changes
May 16, 2018
|
Will plan to incorporate suggested changes and land when I'm back in the office on Friday, |
jasnell
approved these changes
May 23, 2018
|
Pushed commit to address comments |
|
CI good landing. |
|
Landed as 35cf008 |
mhdawson
added a commit
that referenced
this pull request
May 28, 2018
The data pointer returned for the typedarray has already been adjusted by the offset so it does not point to the start of the buffer, instead id points to the start of the first element. I think we probably would have liked it to point to the start of the buffer, but we can't change as that would be a breaking change. Update the doc to match the implementation. PR-URL: #20747 Fixes: nodejs/node-addon-api#244 Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins
pushed a commit
that referenced
this pull request
May 29, 2018
The data pointer returned for the typedarray has already been adjusted by the offset so it does not point to the start of the buffer, instead id points to the start of the first element. I think we probably would have liked it to point to the start of the buffer, but we can't change as that would be a breaking change. Update the doc to match the implementation. PR-URL: #20747 Fixes: nodejs/node-addon-api#244 Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: James M Snell <jasnell@gmail.com>
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.
The data pointer returned for the typedarray has
already been adjusted by the offset so it does not
point to the start of the buffer, instead id points
to the start of the first element.
I think we probably would have liked it to point to the
start of the buffer, but we can't change as that would be
a breaking change.
Update the doc to match the implementation.
Fixes: nodejs/node-addon-api#244
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes.- [X] documentation is changed or added