doc: clarify use of NAPI_EXPERIMENTAL#35195
Closed
mhdawson wants to merge 9 commits intonodejs:masterfrom
Closed
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>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
doc
gengjiawen
approved these changes
Sep 15, 2020
Contributor
gabrielschulhof
left a comment
gabrielschulhof
left a comment
There was a problem hiding this comment.
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>
mhdawson
commented
Sep 17, 2020
Member
Author
|
@gabrielschulhof updated |
gabrielschulhof
approved these changes
Sep 17, 2020
Contributor
gabrielschulhof
left a comment
gabrielschulhof
left a comment
There was a problem hiding this comment.
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.
legendecas
approved these changes
Sep 18, 2020
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Co-authored-by: Gabriel Schulhof <gabrielschulhof@gmail.com>
Member
Author
|
Linters look ok, doc only landing |
mhdawson
added a commit
that referenced
this pull request
Sep 18, 2020
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>
Member
Author
|
Landed in f4586c9 |
ruyadorno
pushed a commit
that referenced
this pull request
Sep 21, 2020
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>
addaleax
pushed a commit
that referenced
this pull request
Sep 22, 2020
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>
Merged
joesepi
pushed a commit
to joesepi/node
that referenced
this pull request
Jan 8, 2021
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>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
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