doc: fix napi version for node_api_symbol_for #42878
Conversation
|
Review requested:
|
nodejs-github-bot
added
doc
danielleadams
force-pushed
the
fix-napi-doc
branch
from
06d4819 to
8d737dc
Compare
There was a problem hiding this comment.
node_api_symbol_for is an experimental feature so it's not part of any Node-API version. For example napi_object_freeze was added as expermental feature in Node.js v14.14.0 and v12.20.0 and promoted as stable api in Node-API v8.
napiVersion should represent the version of Node-API when a feature is promoted as stable.
|
@NickNaso thanks for the explanation. This looked like a typo when pulling into v16.x release and my quick skim through the docs (albeit, probably not thorough) did not find anything. The version section in the docs looks related, could we clarify how |
@danielleadams what I know is that all the features under #ifdef NAPI_EXPERIMENTAL
NAPI_EXTERN napi_status node_api_create_syntax_error(napi_env env,
napi_value code,
napi_value msg,
napi_value* result);
#endif // NAPI_EXPERIMENTALThe files interested are:
I did a look at these files and the following functions should be marked as experimental in the documentation:
The documentation for The documentation for The documentation for The documentation for When these and / or other functions will be promoted as stable a new version of Node-API will be released and at that time the documentation will need to be updated adding the Maybe it's more appropriate fix the documentation in this PR and then open a new PR to clarify how the Node-API version is incremented. I will discuss about this at next Node-API team meeting this friday. |
|
Hi @danielleadams in the today Node-API Team meeting we discussed about this PR and please remove the |
doc/api/n-api.md
Outdated
| napiVersion: | ||
| - v17.5.0 | ||
| - v16.15.0 | ||
| napiVersion: 8 |
There was a problem hiding this comment.
Please remove napiVersion this function is an experimental function.
|
Doc only and linters are passing so landing. |
PR-URL: #42878 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
|
Landed in 0818b52 |
PR-URL: #42878 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: #42878 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: #42878 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: #42878 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
PR-URL: nodejs/node#42878 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
Fixes added
napiversion from Node version to napi version.