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 paramater for napi_get_cb_info #41635

Closed
wants to merge 1 commit into from

Conversation

mhdawson
Copy link
Member

Refs: nodejs/help#3698

Signed-off-by: Michael Dawson mdawson@devrus.com

@nodejs-github-bot
Copy link
Collaborator

nodejs-github-bot commented Jan 21, 2022

Review requested:

  • @nodejs/node-api

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels Jan 21, 2022
doc/api/n-api.md Outdated
@@ -4678,7 +4678,7 @@ napi_status napi_get_cb_info(napi_env env,
* `[in-out] argc`: Specifies the length of the provided `argv` array and
receives the actual count of arguments. `argc` can
optionally be ignored by passing `NULL`.
* `[out] argv`: Buffer to which the `napi_value` representing the arguments are
* `[out] argv`: Array of `napi_values` to which the arguments will be
Copy link
Member

Choose a reason for hiding this comment

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

Unless napi_values is a real type, it should not be in backticks. This document seems to use this instead:

Suggested change
* `[out] argv`: Array of `napi_values` to which the arguments will be
* `[out] argv`: Array of `napi_value`s to which the arguments will be

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

@benjamingr benjamingr 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 the suggestions by Anna and Tobias

@targos
Copy link
Member

targos commented Jan 24, 2022

paramater -> parameter

Refs: nodejs/help#3698

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@mhdawson
Copy link
Member Author

squashed and fixed commit comment.

mhdawson added a commit that referenced this pull request Jan 25, 2022
Refs: nodejs/help#3698

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41635
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
@mhdawson
Copy link
Member Author

Landed in a2dead4

@mhdawson mhdawson closed this Jan 25, 2022
Linkgoron pushed a commit to Linkgoron/node that referenced this pull request Jan 31, 2022
Refs: nodejs/help#3698

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: nodejs#41635
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
ruyadorno pushed a commit that referenced this pull request Feb 8, 2022
Refs: nodejs/help#3698

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41635
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 2, 2022
Refs: nodejs/help#3698

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41635
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 3, 2022
Refs: nodejs/help#3698

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41635
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
danielleadams pushed a commit that referenced this pull request Mar 14, 2022
Refs: nodejs/help#3698

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41635
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

7 participants