summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMichael Dawson <michael_dawson@ca.ibm.com>2019-09-04 15:18:26 -0400
committerRich Trott <rtrott@gmail.com>2019-09-06 21:17:46 -0700
commitbbcbce60718353705460cdc6d8b06df4e2288c08 (patch)
treea4d7dc5b6e28080995f3b9783f583ed417024d88 /doc
parent1cde519287b925a0be4485f3766fb5ceb60f94cd (diff)
downloadandroid-node-v8-bbcbce60718353705460cdc6d8b06df4e2288c08.tar.gz
android-node-v8-bbcbce60718353705460cdc6d8b06df4e2288c08.tar.bz2
android-node-v8-bbcbce60718353705460cdc6d8b06df4e2288c08.zip
doc: simplify wording in n-api doc
Simplify/clarify wording documenting n-api execute callback. PR-URL: https://github.com/nodejs/node/pull/29441 Reviewed-By: Jiawen Geng <technicalcute@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/n-api.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md
index c0cdd9d23d..b8f9d7c0b5 100644
--- a/doc/api/n-api.md
+++ b/doc/api/n-api.md
@@ -548,12 +548,12 @@ operations. Callback functions must satisfy the following signature:
typedef void (*napi_async_execute_callback)(napi_env env, void* data);
```
-Implementations of this type of function should avoid making any N-API calls
-that could result in the execution of JavaScript or interaction with
-JavaScript objects. Most often, any code that needs to make N-API
-calls should be made in `napi_async_complete_callback` instead.
-Avoid using the `napi_env` parameter in the execute callback as
-it will likely execute JavaScript.
+Implementations of this function must avoid making N-API calls
+that execute JavaScript or interact with
+JavaScript objects. N-API
+calls should be in the `napi_async_complete_callback` instead.
+Do not use the `napi_env` parameter as it will likely
+result in execution of JavaScript.
#### napi_async_complete_callback
<!-- YAML