From 63f4a04bdb5aad21e2bacfe26b76b1963dd239eb Mon Sep 17 00:00:00 2001 From: Nick Soggin Date: Wed, 25 Apr 2018 21:14:56 -0400 Subject: [PATCH] docs: minor typos just some small typos in the docs --- doc/array.md | 4 ++-- doc/array_buffer.md | 2 +- doc/async_operations.md | 4 ++-- doc/async_worker.md | 4 ++-- doc/basic_types.md | 4 ++-- doc/buffer.md | 4 ++-- doc/callbackinfo.md | 2 +- doc/class_property_descriptor.md | 4 ++-- doc/creating_a_release.md | 6 +++--- doc/error.md | 4 ++-- doc/error_handling.md | 4 ++-- doc/escapable_handle_sope.md | 4 ++-- doc/function.md | 4 ++-- doc/function_reference.md | 4 ++-- doc/handle_scope.md | 4 ++-- doc/name.md | 4 ++-- doc/node-gyp.md | 4 ++-- doc/object.md | 4 ++-- ...lifetime_management.md => object_lifetime_management.md} | 4 ++-- doc/object_reference.md | 4 ++-- doc/object_wrap.md | 4 ++-- doc/promises.md | 4 ++-- doc/property_descriptor.md | 4 ++-- doc/reference.md | 4 ++-- doc/symbol.md | 4 ++-- doc/typed_array.md | 4 ++-- doc/typed_array_of.md | 4 ++-- doc/value.md | 2 +- doc/working_with_javascript_values.md | 4 ++-- 29 files changed, 56 insertions(+), 56 deletions(-) rename doc/{onject_lifetime_management.md => object_lifetime_management.md} (78%) diff --git a/doc/array.md b/doc/array.md index 613bb66a3..0672fdb04 100644 --- a/doc/array.md +++ b/doc/array.md @@ -1,5 +1,5 @@ # Array -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/array_buffer.md b/doc/array_buffer.md index 58031a673..c6823b95a 100644 --- a/doc/array_buffer.md +++ b/doc/array_buffer.md @@ -1,5 +1,5 @@ # Array buffer -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: [C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/async_operations.md b/doc/async_operations.md index 438312a9b..399346862 100644 --- a/doc/async_operations.md +++ b/doc/async_operations.md @@ -1,5 +1,5 @@ # Asynchronous operations -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/async_worker.md b/doc/async_worker.md index a50f6f777..a1a96890d 100644 --- a/doc/async_worker.md +++ b/doc/async_worker.md @@ -1,5 +1,5 @@ # Async worker -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/basic_types.md b/doc/basic_types.md index e3a94ac20..38e9d3e82 100644 --- a/doc/basic_types.md +++ b/doc/basic_types.md @@ -1,5 +1,5 @@ # Basic Types -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/buffer.md b/doc/buffer.md index 3412b3b27..87d07e38f 100644 --- a/doc/buffer.md +++ b/doc/buffer.md @@ -1,5 +1,5 @@ # Buffer -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/callbackinfo.md b/doc/callbackinfo.md index f4d6a28b4..add1ea00e 100644 --- a/doc/callbackinfo.md +++ b/doc/callbackinfo.md @@ -52,7 +52,7 @@ Returns a `bool` indicating if the function that was invoked (and for which the size_t Length() const; ``` -Returns the number of arguments passed in the Callabckinfo object. +Returns the number of arguments passed in the CallbackInfo object. ### operator [] diff --git a/doc/class_property_descriptor.md b/doc/class_property_descriptor.md index 43f8f204e..cca90d186 100644 --- a/doc/class_property_descriptor.md +++ b/doc/class_property_descriptor.md @@ -1,5 +1,5 @@ # Class propertry and descriptior -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/creating_a_release.md b/doc/creating_a_release.md index 28f1e848a..2e814981e 100644 --- a/doc/creating_a_release.md +++ b/doc/creating_a_release.md @@ -16,8 +16,8 @@ These are the steps to follow to create a new release: * Use https://ci.nodejs.org/view/x%20-%20Abi%20stable%20module%20API/job/node-test-node-addon-api/ to validate tests pass for latest 9, 8, 6, 4 releases - (note there are still some issues on smartos and - windows in the testing). + (note there are still some issues on SmartOS and + Windows in the testing). * Update the version in package.json appropriately. @@ -30,7 +30,7 @@ These are the steps to follow to create a new release: * Login and then run `npm publish`. -* Create a release in github (look at existing releases for an example). +* Create a release in Github (look at existing releases for an example). * Validate that you can run `npm install node-addon-api` successfully and that the correct version is installed. diff --git a/doc/error.md b/doc/error.md index 5ad6befc8..6ffa8842c 100644 --- a/doc/error.md +++ b/doc/error.md @@ -1,5 +1,5 @@ # Error -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/error_handling.md b/doc/error_handling.md index 14c0c4ac0..c54040823 100644 --- a/doc/error_handling.md +++ b/doc/error_handling.md @@ -1,5 +1,5 @@ # Error handling -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/escapable_handle_sope.md b/doc/escapable_handle_sope.md index 37d6ddd66..b5728c465 100644 --- a/doc/escapable_handle_sope.md +++ b/doc/escapable_handle_sope.md @@ -1,5 +1,5 @@ # Escapable handle scope -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/function.md b/doc/function.md index 4b607858b..e4d7c92fc 100644 --- a/doc/function.md +++ b/doc/function.md @@ -1,5 +1,5 @@ # Function -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/function_reference.md b/doc/function_reference.md index 1ffe8ddfe..1978b81b4 100644 --- a/doc/function_reference.md +++ b/doc/function_reference.md @@ -1,5 +1,5 @@ # Function reference -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/handle_scope.md b/doc/handle_scope.md index 2bf03becc..5feb5241f 100644 --- a/doc/handle_scope.md +++ b/doc/handle_scope.md @@ -1,5 +1,5 @@ # Handle scope -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/name.md b/doc/name.md index 9549d71b2..1563f2b8b 100644 --- a/doc/name.md +++ b/doc/name.md @@ -1,5 +1,5 @@ # Name -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/node-gyp.md b/doc/node-gyp.md index 851b3179b..22e3bcaef 100644 --- a/doc/node-gyp.md +++ b/doc/node-gyp.md @@ -4,8 +4,8 @@ C++ code needs to be compiled into executable form whether it be as an object file to linked with others, a shared library, or a standalone executable. The main reason for this is that we need to link to the Node.js dependencies and -headers correcrtly, another reason is that we need a cross platform way to build -C++ soucre into binary for the target platform, +headers correctly, another reason is that we need a cross platform way to build +C++ source into binary for the target platform. Until now **node-gyp** is the **de-facto** standard build tool for writing Node.js addons. It's based on Google's **gyp** build tool, which abstract away diff --git a/doc/object.md b/doc/object.md index 1f46ace2f..dc9e11343 100644 --- a/doc/object.md +++ b/doc/object.md @@ -1,5 +1,5 @@ # Object -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/onject_lifetime_management.md b/doc/object_lifetime_management.md similarity index 78% rename from doc/onject_lifetime_management.md rename to doc/object_lifetime_management.md index cf9d2a200..f9a4351bf 100644 --- a/doc/onject_lifetime_management.md +++ b/doc/object_lifetime_management.md @@ -1,5 +1,5 @@ # Object lifetime management -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/object_reference.md b/doc/object_reference.md index 2d80341ca..fcc4d9d45 100644 --- a/doc/object_reference.md +++ b/doc/object_reference.md @@ -1,5 +1,5 @@ # Object reference -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/object_wrap.md b/doc/object_wrap.md index d2349f044..9f4422e61 100644 --- a/doc/object_wrap.md +++ b/doc/object_wrap.md @@ -8,6 +8,6 @@ Classes extending ```ObjectWrap``` can be instantiated from JavaScript using the The **wrap** word refers to a way to group methods and state of your class because it will be your responsibility write custom code to bridge each of your C++ class methods. -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/promises.md b/doc/promises.md index 34c56a916..40fc9fa69 100644 --- a/doc/promises.md +++ b/doc/promises.md @@ -1,5 +1,5 @@ # Promise -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/property_descriptor.md b/doc/property_descriptor.md index bb49e1703..65bf400ad 100644 --- a/doc/property_descriptor.md +++ b/doc/property_descriptor.md @@ -1,5 +1,5 @@ # property descriptor -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/reference.md b/doc/reference.md index bd78a7c1b..e7580befa 100644 --- a/doc/reference.md +++ b/doc/reference.md @@ -1,5 +1,5 @@ # Reference -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/symbol.md b/doc/symbol.md index ab4b36e2b..f644d137f 100644 --- a/doc/symbol.md +++ b/doc/symbol.md @@ -1,5 +1,5 @@ # Symbol -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/typed_array.md b/doc/typed_array.md index cc33682eb..43f5bfea7 100644 --- a/doc/typed_array.md +++ b/doc/typed_array.md @@ -1,5 +1,5 @@ # Typed array -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/typed_array_of.md b/doc/typed_array_of.md index c87f281e2..4ed65485a 100644 --- a/doc/typed_array_of.md +++ b/doc/typed_array_of.md @@ -1,5 +1,5 @@ # Typed array of -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) diff --git a/doc/value.md b/doc/value.md index 19a08bee6..5e79d352e 100644 --- a/doc/value.md +++ b/doc/value.md @@ -4,7 +4,7 @@ Value is the C++ manifestation of a JavaScript value. -Value is a the base class upon which other JavaScipt values such as Number, Boolean, String, and Object are based. +Value is a the base class upon which other JavaScript values such as Number, Boolean, String, and Object are based. The following classes inherit, either directly or indirectly, from Value: diff --git a/doc/working_with_javascript_values.md b/doc/working_with_javascript_values.md index e15f7c71d..0c5cbe2ee 100644 --- a/doc/working_with_javascript_values.md +++ b/doc/working_with_javascript_values.md @@ -1,5 +1,5 @@ # Working with JavaScript Values -You are reading a draft of the next documentation and it's in continuos update so +You are reading a draft of the next documentation and it's in continuous update so if you don't find what you need please refer to: -[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/) \ No newline at end of file +[C++ wrapper classes for the ABI-stable C APIs for Node.js](https://nodejs.github.io/node-addon-api/)