Skip to content

Commit a9d16b5

Browse files
mhdawsontargos
authored andcommitted
doc: simplify wording in n-api doc
Simplify/clarify wording documenting n-api execute callback. PR-URL: #29441 Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent fa949ca commit a9d16b5

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

doc/api/n-api.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -548,12 +548,12 @@ operations. Callback functions must satisfy the following signature:
548548
typedef void (*napi_async_execute_callback)(napi_env env, void* data);
549549
```
550550

551-
Implementations of this type of function should avoid making any N-API calls
552-
that could result in the execution of JavaScript or interaction with
553-
JavaScript objects. Most often, any code that needs to make N-API
554-
calls should be made in `napi_async_complete_callback` instead.
555-
Avoid using the `napi_env` parameter in the execute callback as
556-
it will likely execute JavaScript.
551+
Implementations of this function must avoid making N-API calls
552+
that execute JavaScript or interact with
553+
JavaScript objects. N-API
554+
calls should be in the `napi_async_complete_callback` instead.
555+
Do not use the `napi_env` parameter as it will likely
556+
result in execution of JavaScript.
557557

558558
#### napi_async_complete_callback
559559
<!-- YAML

0 commit comments

Comments
 (0)