diff options
author | Rich Trott <rtrott@gmail.com> | 2018-06-17 22:38:24 -0700 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2018-06-18 14:07:59 -0700 |
commit | 4970e2bec8a15739739ac4317158233c8cf32c6d (patch) | |
tree | 3f8449adc0ec2905f3e96f12591dee90615f9378 /doc/api/n-api.md | |
parent | 8fa640e2db60e74d24b15de95f51fd9b55f5e793 (diff) | |
download | android-node-v8-4970e2bec8a15739739ac4317158233c8cf32c6d.tar.gz android-node-v8-4970e2bec8a15739739ac4317158233c8cf32c6d.tar.bz2 android-node-v8-4970e2bec8a15739739ac4317158233c8cf32c6d.zip |
doc: eliminate _you_ from N-API doc
The STYLE_GUIDE indicates that personal pronouns like "you" should be
avoided in reference documentation. Remove "you" from N-API doc.
PR-URL: https://github.com/nodejs/node/pull/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>
Diffstat (limited to 'doc/api/n-api.md')
-rw-r--r-- | doc/api/n-api.md | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index ef2396409b..5a9c81e369 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -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] 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 callback throws an exception with no way to recover. @@ -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 -of the Node.js process, you can use the `NAPI_MODULE_INIT` macro to initialize -your module: +If the module will be loaded multiple times during the lifetime of the Node.js +process, use the `NAPI_MODULE_INIT` macro to initialize the module: ```C NAPI_MODULE_INIT() { |