From c4c206583c1a840d8a48a22ae4303ec23f97abab Mon Sep 17 00:00:00 2001 From: Kenvin Davies Date: Mon, 26 Oct 2020 16:11:02 -0300 Subject: [PATCH] Fix: some typos in documentation (#826) --- doc/async_context.md | 2 +- doc/async_worker.md | 2 +- doc/boolean.md | 2 +- doc/checker-tool.md | 2 +- doc/creating_a_release.md | 2 +- doc/escapable_handle_scope.md | 2 +- doc/function.md | 4 ++-- doc/function_reference.md | 2 +- doc/handle_scope.md | 2 +- doc/number.md | 2 +- doc/object_lifetime_management.md | 2 +- doc/prebuild_tools.md | 4 ++-- doc/property_descriptor.md | 6 +++--- doc/threadsafe_function.md | 6 +++--- doc/version_management.md | 4 ++-- 15 files changed, 22 insertions(+), 22 deletions(-) diff --git a/doc/async_context.md b/doc/async_context.md index 8e1f481..b217d33 100644 --- a/doc/async_context.md +++ b/doc/async_context.md @@ -73,7 +73,7 @@ void MakeCallbackWithAsyncContext(const Napi::CallbackInfo& info) { Napi::Function callback = info[0].As(); Napi::Object resource = info[1].As(); - // Creat a new async context instance. + // Create a new async context instance. Napi::AsyncContext context(info.Env(), "async_context_test", resource); // Invoke the callback with the async context instance. diff --git a/doc/async_worker.md b/doc/async_worker.md index d7753ac..b6bb0cd 100644 --- a/doc/async_worker.md +++ b/doc/async_worker.md @@ -395,7 +395,7 @@ class EchoWorker : public AsyncWorker { }; ``` -The `EchoWorker`'s contructor calls the base class' constructor to pass in the +The `EchoWorker`'s constructor calls the base class' constructor to pass in the callback that the `Napi::AsyncWorker` base class will store persistently. When the work on the `Napi::AsyncWorker::Execute` method is done the `Napi::AsyncWorker::OnOk` method is called and the results return back to diff --git a/doc/boolean.md b/doc/boolean.md index d07daa2..6a8ec3f 100644 --- a/doc/boolean.md +++ b/doc/boolean.md @@ -18,7 +18,7 @@ Napi::Boolean::Boolean(); Returns a new _empty_ `Napi::Boolean` object. -### Contructor +### Constructor Creates a new instance of the `Napi::Boolean` object. diff --git a/doc/checker-tool.md b/doc/checker-tool.md index 499d3ab..135f13f 100644 --- a/doc/checker-tool.md +++ b/doc/checker-tool.md @@ -26,7 +26,7 @@ indicating for each addon whether it is an N-API addon. ``` The tool accepts the root directory from which to start checking for Node.js -native addons as a single optional command line parameter. If ommitted it will +native addons as a single optional command line parameter. If omitted it will start checking from the current directory (`.`). [checker tool]: ../tools/check-napi.js diff --git a/doc/creating_a_release.md b/doc/creating_a_release.md index beb67d2..5c8f8b0 100644 --- a/doc/creating_a_release.md +++ b/doc/creating_a_release.md @@ -36,7 +36,7 @@ the route folder of the repo launch the following command: ```bash > changelog-maker ``` -* Use the output generated by **changelog maker** to pdate the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md) +* Use the output generated by **changelog maker** to update the [CHANGELOG.md](https://github.com/nodejs/node-addon-api/blob/master/CHANGELOG.md) following the style used in publishing the previous release. * Add any new contributors to the "contributors" section in the package.json diff --git a/doc/escapable_handle_scope.md b/doc/escapable_handle_scope.md index 978aab3..4f3e2d0 100644 --- a/doc/escapable_handle_scope.md +++ b/doc/escapable_handle_scope.md @@ -59,7 +59,7 @@ Napi::EscapableHandleScope::~EscapableHandleScope(); Deletes the `Napi::EscapableHandleScope` instance and allows any objects/handles created in the scope to be collected by the garbage collector. There is no -guarantee as to when the gargbage collector will do this. +guarantee as to when the garbage collector will do this. ### Escape diff --git a/doc/function.md b/doc/function.md index 610d100..ddc089c 100644 --- a/doc/function.md +++ b/doc/function.md @@ -218,7 +218,7 @@ Napi::Object Napi::Function::New(const std::initializer_list& args) ``` - `[in] args`: Initializer list of JavaScript values as `napi_value` representing -the arguments of the contructor function. +the arguments of the constructor function. Returns a new JavaScript object. @@ -245,7 +245,7 @@ object. Napi::Object Napi::Function::New(size_t argc, const napi_value* args) const; ``` -- `[in] argc`: The number of the arguments passed to the contructor function. +- `[in] argc`: The number of the arguments passed to the constructor function. - `[in] args`: Array of JavaScript values as `napi_value` representing the arguments of the constructor function. diff --git a/doc/function_reference.md b/doc/function_reference.md index 7b299b9..fa21830 100644 --- a/doc/function_reference.md +++ b/doc/function_reference.md @@ -73,7 +73,7 @@ Napi::Object Napi::FunctionReference::New(const std::initializer_list