Skip to content

doc: rename N-API with Node-API#951

Closed
RaisinTen wants to merge 4 commits intonodejs:mainfrom
RaisinTen:doc/rename-N-API-with-Node-API
Closed

doc: rename N-API with Node-API#951
RaisinTen wants to merge 4 commits intonodejs:mainfrom
RaisinTen:doc/rename-N-API-with-Node-API

Conversation

@RaisinTen
Copy link
Copy Markdown
Member

@RaisinTen RaisinTen commented Mar 25, 2021

Done by running:

sed -i "s/N-API/Node-API/g" doc/*

Fixes: #950

@RaisinTen
doc: rename N-API with Node-API
1980f06 
Done by running:
sed -i "s/N-API/Node-API/g" doc/*

Fixes: nodejs#950
@RaisinTen RaisinTen mentioned this pull request Mar 25, 2021
Closed
NickNaso
NickNaso reviewed Mar 25, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@NickNaso NickNaso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @RaisinTen,
thanks for doing this. I found some little erros on documentation and reported to you. Could you fix them?

Comment thread doc/async_worker.md Outdated

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
Copy link
Copy Markdown
Member

@NickNaso NickNaso Mar 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you use backtick for napi_async_work? From napi_async_work to napi_async_work

Comment thread 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
Copy link
Copy Markdown
Member

@NickNaso NickNaso Mar 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you use backtick for napi_escapable_handle_scope? From napi_escapable_handle_scope to napi_escapable_handle_scope

Comment thread doc/escapable_handle_scope.md Outdated

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.
Copy link
Copy Markdown
Member

@NickNaso NickNaso Mar 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you use backtick for napi_escapable_handle_scope? From napi_escapable_handle_scope to napi_escapable_handle_scope

Comment thread doc/handle_scope.md Outdated

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.
Copy link
Copy Markdown
Member

@NickNaso NickNaso Mar 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you use backtick for napi_handle_scope? From napi_handle_scope to napi_handle_scope

Comment thread 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
Copy link
Copy Markdown
Member

@NickNaso NickNaso Mar 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you use backtick for napi_handle_scope? From napi_handle_scope to napi_handle_scope

@NickNaso
Copy link
Copy Markdown
Member

NickNaso commented Mar 25, 2021 •
edited
Loading

Could you also update the files listed below?

  • README.md
  • CONTRIBUTING.md

@NickNaso NickNaso added the doc label Mar 25, 2021
@RaisinTen
Copy link
Copy Markdown
Member Author

RaisinTen commented Mar 26, 2021

@NickNaso Thanks for the review. I have added your suggestions. PTAL.

mhdawson
mhdawson approved these changes Mar 26, 2021
View reviewed changes
Copy link
Copy Markdown
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@NickNaso NickNaso mentioned this pull request Mar 27, 2021
Merged
gabrielschulhof pushed a commit that referenced this pull request Mar 29, 2021
@RaisinTen @gabrielschulhof
doc: rename N-API with Node-API
787e216 
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: #950
PR-URL: #951
Reviewed-By: Nicola Del Gobbo <nicoladelgobbo@gmail.com>
Reviewed-By: Gabriel Schulhof <gabrielschulhof@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>
@gabrielschulhof
Copy link
Copy Markdown
Contributor

gabrielschulhof commented Mar 29, 2021

Landed in 787e216.

@RaisinTen RaisinTen deleted the doc/rename-N-API-with-Node-API branch March 30, 2021 15:28
deepakrkris pushed a commit to deepakrkris/node-addon-api that referenced this pull request Sep 23, 2021
@RaisinTen
doc: rename N-API with Node-API
22c67da 
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
@RaisinTen
doc: rename N-API with Node-API
91c9861 
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
@kevindavies8
doc: rename N-API with Node-API
e981f0b 
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
@Marlyfleitas
doc: rename N-API with Node-API
1f71749 
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
@wroy7860
doc: rename N-API with Node-API
fdbc280 
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
doc: rename N-API with Node-API
56a9b57 
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

Reviewers

@NickNaso NickNaso NickNaso approved these changes

@gabrielschulhof gabrielschulhof gabrielschulhof approved these changes

@mhdawson mhdawson mhdawson approved these changes

Assignees

No one assigned

Labels

doc

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

doc: rename N-API to Node-API

4 participants

@RaisinTen @NickNaso @gabrielschulhof @mhdawson