From bbcbce60718353705460cdc6d8b06df4e2288c08 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 4 Sep 2019 15:18:26 -0400 Subject: [PATCH] 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 Reviewed-By: Richard Lau Reviewed-By: Trivikram Kamat Reviewed-By: Rich Trott Reviewed-By: Colin Ihrig Reviewed-By: Luigi Pinca --- doc/api/n-api.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index c0cdd9d23dd578..b8f9d7c0b53a69 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