-
-
Notifications
You must be signed in to change notification settings - Fork 31.6k
doc: clarify use of NAPI_EXPERIMENTAL #35195
New issue
Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? # to your account
Conversation
We've had a few questions about APIs not being available which were related to not having specified `NAPI_EXPERIMENTAL`. Add some additional documentation to explain this common issue: Refs: nodejs/node-addon-api#810 Signed-off-by: Michael Dawson <mdawson@devrus.com>
Review requested:
|
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
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.
Per our guidelines we should avoid using "you" in our documentation. I tried to re-word it more passively.
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
@gabrielschulhof updated |
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.
I realized that as it is the doc never explains that N-API version:
and added in:
are headers accompanying each N-API. I suggested improved wording to explain that.
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Linters look ok, doc only landing |
We've had a few questions about APIs not being available which were related to not having specified `NAPI_EXPERIMENTAL`. Add some additional documentation to explain this common issue: Refs: nodejs/node-addon-api#810 Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #35195 Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Landed in f4586c9 |
We've had a few questions about APIs not being available which were related to not having specified `NAPI_EXPERIMENTAL`. Add some additional documentation to explain this common issue: Refs: nodejs/node-addon-api#810 Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #35195 Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
We've had a few questions about APIs not being available which were related to not having specified `NAPI_EXPERIMENTAL`. Add some additional documentation to explain this common issue: Refs: nodejs/node-addon-api#810 Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #35195 Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
We've had a few questions about APIs not being available which were related to not having specified `NAPI_EXPERIMENTAL`. Add some additional documentation to explain this common issue: Refs: nodejs/node-addon-api#810 Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: nodejs#35195 Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Gabriel Schulhof <gabriel.schulhof@intel.com> Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
We've had a few questions about APIs not being available which
were related to not having specified
NAPI_EXPERIMENTAL
.Add some additional documentation to explain this common
issue:
Refs: nodejs/node-addon-api#810
Signed-off-by: Michael Dawson mdawson@devrus.com
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passes