Skip to content

Commit c9226f5

Browse files
cjihrigtargos
authored andcommitted
doc: drop 'Note that' in addons docs
This commit removes the usage of 'Note that' in the addons documentation. Note that this phrase was not adding anything meaningful to the docs. PR-URL: #28327 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Anna Henningsen <[email protected]>
1 parent a213eb7 commit c9226f5

File tree

1 file changed

+8
-9
lines changed

1 file changed

+8
-9
lines changed

doc/api/addons.md

+8-9
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ NODE_MODULE(NODE_GYP_MODULE_NAME, Initialize)
8383
} // namespace demo
8484
```
8585
86-
Note that all Node.js Addons must export an initialization function following
86+
All Node.js Addons must export an initialization function following
8787
the pattern:
8888
8989
```cpp
@@ -310,9 +310,8 @@ Because the exact path to the compiled Addon binary can vary depending on how
310310
it is compiled (i.e. sometimes it may be in `./build/Debug/`), Addons can use
311311
the [bindings][] package to load the compiled module.
312312

313-
Note that while the `bindings` package implementation is more sophisticated
314-
in how it locates Addon modules, it is essentially using a try-catch pattern
315-
similar to:
313+
While the `bindings` package implementation is more sophisticated in how it
314+
locates Addon modules, it is essentially using a try-catch pattern similar to:
316315

317316
```js
318317
try {
@@ -588,10 +587,10 @@ NODE_MODULE(NODE_GYP_MODULE_NAME, Init)
588587
} // namespace demo
589588
```
590589
591-
Note that this example uses a two-argument form of `Init()` that receives
592-
the full `module` object as the second argument. This allows the Addon
593-
to completely overwrite `exports` with a single function instead of
594-
adding the function as a property of `exports`.
590+
This example uses a two-argument form of `Init()` that receives the full
591+
`module` object as the second argument. This allows the Addon to completely
592+
overwrite `exports` with a single function instead of adding the function as a
593+
property of `exports`.
595594
596595
To test it, run the following JavaScript:
597596
@@ -605,7 +604,7 @@ addon((msg) => {
605604
});
606605
```
607606

608-
Note that, in this example, the callback function is invoked synchronously.
607+
In this example, the callback function is invoked synchronously.
609608

610609
### Object factory
611610

0 commit comments

Comments
 (0)