Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify behavior of napi_get_typedarray_info #32603

Closed
wants to merge 9 commits into from

Conversation

mhdawson
Copy link
Member

@mhdawson mhdawson commented Apr 1, 2020

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

Fixes: #32089

@nodejs-github-bot nodejs-github-bot added build Issues and PRs related to build files or the CI. post-mortem Issues and PRs related to the post-mortem diagnostics of Node.js. v8 engine Issues and PRs related to the V8 dependency. labels Apr 1, 2020
@mhdawson mhdawson changed the title Napi undef Needs Fixup - WIP - Napi undef Apr 1, 2020
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>

Fixes: nodejs#32089
@mhdawson mhdawson changed the title Needs Fixup - WIP - Napi undef doc: clarify behavior of napi_get_typedarray_info Apr 1, 2020
Copy link
Member

@legendecas legendecas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The statement can be documented under napi_get_arraybuffer_info/napi_get_buffer_info/napi_get_dataview_info too.

@mhdawson
Copy link
Member Author

mhdawson commented Apr 2, 2020

@legendecas updated, can you take another look.

doc/api/n-api.md Outdated Show resolved Hide resolved
Copy link
Member

@jasnell jasnell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with @addaleax's suggestion

@addaleax addaleax added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. and removed v8 engine Issues and PRs related to the V8 dependency. build Issues and PRs related to build files or the CI. post-mortem Issues and PRs related to the post-mortem diagnostics of Node.js. labels Apr 5, 2020
doc/api/n-api.md Outdated Show resolved Hide resolved
doc/api/n-api.md Outdated Show resolved Hide resolved
doc/api/n-api.md Outdated Show resolved Hide resolved
doc/api/n-api.md Outdated Show resolved Hide resolved
Copy link
Member

@Trott Trott left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left style suggesitons and a comment/question, but LGTM

mhdawson and others added 5 commits April 8, 2020 10:58
Co-Authored-By: Rich Trott <rtrott@gmail.com>
Co-Authored-By: Rich Trott <rtrott@gmail.com>
Co-Authored-By: Rich Trott <rtrott@gmail.com>
Co-Authored-By: Rich Trott <rtrott@gmail.com>
@mhdawson
Copy link
Member Author

mhdawson commented Apr 8, 2020

@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

@mhdawson
Copy link
Member Author

mhdawson commented Apr 8, 2020

Oops forgot as doc only change it just needs the GitHub actions to pass as opposed to full run. Will land as linters have passed.

mhdawson added a commit that referenced this pull request Apr 8, 2020
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>

Fixes: #32089

PR-URL: #32603
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@mhdawson
Copy link
Member Author

mhdawson commented Apr 8, 2020

Landed in 2681cba

@mhdawson mhdawson closed this Apr 8, 2020
targos pushed a commit that referenced this pull request Apr 12, 2020
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>

Fixes: #32089

PR-URL: #32603
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 14, 2020
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>

Fixes: #32089

PR-URL: #32603
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
targos pushed a commit that referenced this pull request Apr 22, 2020
Signed-off-by: Michael Dawson <michael_dawson@ca.ibm.com>

Fixes: #32089

PR-URL: #32603
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@mhdawson mhdawson deleted the napi-undef branch September 14, 2020 21:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

napi: zero length typedarray in 12 vs 13
6 participants