Navigation Menu

Skip to content

Commit

Permalink
doc: eliminate _you_ from N-API doc
Browse files Browse the repository at this point in the history
The STYLE_GUIDE indicates that personal pronouns like "you" should be
avoided in reference documentation. Remove "you" from N-API doc.

PR-URL: #21382
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
  • Loading branch information
Trott committed Jun 18, 2018
1 parent 8fa640e commit 4970e2b
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions doc/api/n-api.md
Expand Up @@ -536,7 +536,7 @@ napi_status napi_fatal_exception(napi_env env, napi_value err);
``` ```
- `[in] env`: The environment that the API is invoked under. - `[in] env`: The environment that the API is invoked under.
- `[in] err`: The error you want to pass to `'uncaughtException'`. - `[in] err`: The error that is passed to `'uncaughtException'`.
Trigger an `'uncaughtException'` in JavaScript. Useful if an async Trigger an `'uncaughtException'` in JavaScript. Useful if an async
callback throws an exception with no way to recover. callback throws an exception with no way to recover.
Expand Down Expand Up @@ -1019,9 +1019,8 @@ napi_value Init(napi_env env, napi_value exports) {
} }
``` ```
If you expect that your module will be loaded multiple times during the lifetime If the module will be loaded multiple times during the lifetime of the Node.js
of the Node.js process, you can use the `NAPI_MODULE_INIT` macro to initialize process, use the `NAPI_MODULE_INIT` macro to initialize the module:
your module:
```C ```C
NAPI_MODULE_INIT() { NAPI_MODULE_INIT() {
Expand Down

0 comments on commit 4970e2b

Please sign in to comment.