-
Notifications
You must be signed in to change notification settings - Fork 29.7k
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
Conversation
Review requested:
|
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 |
There was a problem hiding this comment.
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:
* `[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 |
There was a problem hiding this 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
paramater -> parameter |
Refs: nodejs/help#3698 Signed-off-by: Michael Dawson <mdawson@devrus.com>
squashed and fixed commit comment. |
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>
Landed in a2dead4 |
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>
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>
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>
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>
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>
Refs: nodejs/help#3698
Signed-off-by: Michael Dawson mdawson@devrus.com