Skip to content

Commit a7625d5

Browse files
Rawal27aduh95
authored andcommitted
doc: fix grammar and editorial issues in addons documentation
Signed-off-by: Rawal27 <obviouslykamal@gmail.com> PR-URL: #64952 Reviewed-By: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Reviewed-By: Richard Lau <richard.lau@ibm.com> Reviewed-By: Rich Trott <rtrott@gmail.com>
1 parent 4de7938 commit a7625d5

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

doc/api/addons.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ There are three options for implementing addons:
1414
* `nan` ([Native Abstractions for Node.js][])
1515
* direct use of internal V8, libuv, and Node.js libraries
1616

17-
This rest of this document focuses on the latter, requiring
17+
The rest of this document focuses on the latter, requiring
1818
knowledge of multiple components and APIs:
1919

2020
* [V8][]: the C++ library Node.js uses to provide the
@@ -113,7 +113,7 @@ To integrate with the npm ecosystem, see the [Building][] section.
113113

114114
### Context-aware addons
115115

116-
Addons defined with `NODE_MODULE()` can not be loaded in multiple contexts or
116+
Addons defined with `NODE_MODULE()` cannot be loaded in multiple contexts or
117117
multiple threads at the same time.
118118

119119
There are environments in which Node.js addons may need to be loaded multiple
@@ -255,7 +255,7 @@ changes:
255255
In order to be loaded from multiple Node.js environments,
256256
such as a main thread and a Worker thread, an add-on needs to either:
257257

258-
* Be an [Node-API][] addon.
258+
* Be a [Node-API][] addon.
259259
* Be declared as context-aware using `NODE_MODULE_INIT()` as described above.
260260

261261
In order to support [`Worker`][] threads, addons need to clean up any resources
@@ -487,13 +487,13 @@ See [C/C++ addons with Node-API][Node-API].
487487

488488
## Addon examples
489489

490-
Following are some example addons intended to help developers get started. The
490+
The following are some example addons intended to help developers get started. The
491491
examples use the V8 APIs. Refer to the online [V8 reference][v8-docs]
492492
for help with the various V8 calls, and V8's [Embedder's Guide][] for an
493493
explanation of several concepts used such as handles, scopes, function
494494
templates, etc.
495495

496-
Each of these examples using the following `binding.gyp` file:
496+
Each of these examples uses the following `binding.gyp` file:
497497

498498
```json
499499
{
@@ -979,7 +979,7 @@ provided by the underlying V8 JavaScript engine. They are subject to change
979979
or removal at any time. They are not documented by Node.js or V8, and they
980980
should never be used outside of testing.
981981

982-
During shutdown of the process or worker threads destructors are not called
982+
During shutdown of the process or worker threads, destructors are not called
983983
by the JS engine. Therefore it's the responsibility of the user to track
984984
these objects and ensure proper destruction to avoid resource leaks.
985985

@@ -1208,7 +1208,7 @@ console.log(obj2.plusOne());
12081208

12091209
In addition to wrapping and returning C++ objects, it is possible to pass
12101210
wrapped objects around by unwrapping them with the Node.js helper function
1211-
`node::ObjectWrap::Unwrap`. The following examples shows a function `add()`
1211+
`node::ObjectWrap::Unwrap`. The following example shows a function `add()`
12121212
that can take two `MyObject` objects as input arguments:
12131213

12141214
<!-- addon-verify-file passing_wrapped_objects_around/addon.cc -->

0 commit comments

Comments
 (0)