doc: rename N-API with Node-API #951
Closed
Conversation
This file contains 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
Done by running: sed -i "s/N-API/Node-API/g" doc/* Fixes: nodejs#950
NickNaso
reviewed
Mar 25, 2021
There was a problem hiding this comment.
Hi @RaisinTen,
thanks for doing this. I found some little erros on documentation and reported to you. Could you fix them?
doc/async_worker.md
Outdated
| @@ -343,8 +343,8 @@ virtual Napi::AsyncWorker::~AsyncWorker(); | |||
| Napi::AsyncWorker::operator napi_async_work() const; | |||
| ``` | |||
|
|
|||
| Returns the N-API napi_async_work wrapped by the `Napi::AsyncWorker` object. This | |||
| can be used to mix usage of the C N-API and node-addon-api. | |||
| Returns the Node-API napi_async_work wrapped by the `Napi::AsyncWorker` object. This | |||
There was a problem hiding this comment.
Could you use backtick for napi_async_work? From napi_async_work to napi_async_work
doc/escapable_handle_scope.md
Outdated
| @@ -40,16 +40,16 @@ Napi::EscapableHandleScope Napi::EscapableHandleScope::New(napi_env env, napi_ha | |||
|
|
|||
| Returns a new `Napi::EscapableHandleScope` instance which wraps the | |||
| napi_escapable_handle_scope handle passed in. This can be used | |||
There was a problem hiding this comment.
Could you use backtick for napi_escapable_handle_scope? From napi_escapable_handle_scope to napi_escapable_handle_scope
doc/escapable_handle_scope.md
Outdated
|
|
||
| operator EscapableHandleScope::napi_escapable_handle_scope | ||
|
|
||
| ```cpp | ||
| operator Napi::EscapableHandleScope::napi_escapable_handle_scope() const | ||
| ``` | ||
|
|
||
| Returns the N-API napi_escapable_handle_scope wrapped by the `Napi::EscapableHandleScope` object. | ||
| This can be used to mix usage of the C N-API and node-addon-api by allowing | ||
| Returns the Node-API napi_escapable_handle_scope wrapped by the `Napi::EscapableHandleScope` object. |
There was a problem hiding this comment.
Could you use backtick for napi_escapable_handle_scope? From napi_escapable_handle_scope to napi_escapable_handle_scope
doc/handle_scope.md
Outdated
| @@ -43,8 +43,8 @@ operator HandleScope::napi_handle_scope | |||
| operator Napi::HandleScope::napi_handle_scope() const | |||
| ``` | |||
|
|
|||
| Returns the N-API napi_handle_scope wrapped by the `Napi::EscapableHandleScope` object. | |||
| This can be used to mix usage of the C N-API and node-addon-api by allowing | |||
| Returns the Node-API napi_handle_scope wrapped by the `Napi::EscapableHandleScope` object. | |||
There was a problem hiding this comment.
Could you use backtick for napi_handle_scope? From napi_handle_scope to napi_handle_scope
doc/handle_scope.md
Outdated
| @@ -34,7 +34,7 @@ Napi::HandleScope::HandleScope(Napi::Env env, Napi::HandleScope scope); | |||
| - `[in] scope`: pre-existing `Napi::HandleScope`. | |||
|
|
|||
| Returns a new `Napi::HandleScope` instance which wraps the napi_handle_scope | |||
There was a problem hiding this comment.
Could you use backtick for napi_handle_scope? From napi_handle_scope to napi_handle_scope
|
Could you also update the files listed below?
|
Done by running: sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md
|
@NickNaso Thanks for the review. I have added your suggestions. PTAL. |
NickNaso
approved these changes
Mar 27, 2021
gabrielschulhof
approved these changes
Mar 29, 2021
|
Landed in 787e216. |
deepakrkris
pushed a commit
to deepakrkris/node-addon-api
that referenced
this pull request
Sep 23, 2021
Done by running: sed -i "s/N-API/Node-API/g" doc/* sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md Fixes: nodejs#950 PR-URL: nodejs#951 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
deepakrkris
pushed a commit
to deepakrkris/node-addon-api
that referenced
this pull request
Oct 15, 2021
Done by running: sed -i "s/N-API/Node-API/g" doc/* sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md Fixes: nodejs#950 PR-URL: nodejs#951 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
kevindavies8
added a commit
to kevindavies8/node-addon-api-Develop
that referenced
this pull request
Aug 24, 2022
Done by running: sed -i "s/N-API/Node-API/g" doc/* sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md Fixes: nodejs/node-addon-api#950 PR-URL: nodejs/node-addon-api#951 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
Marlyfleitas
added a commit
to Marlyfleitas/node-api-addon-Development
that referenced
this pull request
Aug 26, 2022
Done by running: sed -i "s/N-API/Node-API/g" doc/* sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md Fixes: nodejs/node-addon-api#950 PR-URL: nodejs/node-addon-api#951 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
wroy7860
added a commit
to wroy7860/addon-api-benchmark-node
that referenced
this pull request
Sep 19, 2022
Done by running: sed -i "s/N-API/Node-API/g" doc/* sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md Fixes: nodejs/node-addon-api#950 PR-URL: nodejs/node-addon-api#951 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
austinli64
added a commit
to austinli64/node-addon-api
that referenced
this pull request
May 9, 2023
Done by running: sed -i "s/N-API/Node-API/g" doc/* sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md Fixes: nodejs/node-addon-api#950 PR-URL: nodejs/node-addon-api#951 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
johnfrench3
pushed a commit
to johnfrench3/node-addon-api-git
that referenced
this pull request
Aug 11, 2023
Done by running: sed -i "s/N-API/Node-API/g" doc/* sed -i "s/N-API/Node-API/g" README.md CONTRIBUTING.md Fixes: nodejs/node-addon-api#950 PR-URL: nodejs/node-addon-api#951 Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com> Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Done by running:
Fixes: #950