diff options
| author | Michael Dawson <michael_dawson@ca.ibm.com> | 2018-01-16 22:05:26 +0300 |
|---|---|---|
| committer | Myles Borins <mylesborins@google.com> | 2018-05-02 00:16:29 +0300 |
| commit | 84e0a0372717185715949401ad625cc54c6d7b75 (patch) | |
| tree | eadf05c6001bcfc4f34c88c8b2a62c1144cf1788 /doc/api/n-api.md | |
| parent | 8cfa87832d151344a7048ba9fd646136a07a0cb2 (diff) | |
doc: remove uannecessary Require
This was the only instance were we said a parameter
was required. It is assumed parameters are required unless
the doc says they are option. Remove `Required` to make
consistent with the rest of the doc
Backport-PR-URL: https://github.com/nodejs/node/pull/19265
PR-URL: https://github.com/nodejs/node/pull/18184
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Diffstat (limited to 'doc/api/n-api.md')
| -rw-r--r-- | doc/api/n-api.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/n-api.md b/doc/api/n-api.md index d884853ec41..9b780803e27 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -3283,7 +3283,7 @@ napi_status napi_create_async_work(napi_env env, - `[in] env`: The environment that the API is invoked under. - `[in] async_resource`: An optional object associated with the async work that will be passed to possible async_hooks [`init` hooks][]. -- `[in] async_resource_name`: An identifier for the kind of resource that is +- `[in] async_resource_name`: Identifier for the kind of resource that is being provided for diagnostic information exposed by the `async_hooks` API. - `[in] execute`: The native function which should be called to excute the logic asynchronously. @@ -3382,7 +3382,7 @@ napi_status napi_async_init(napi_env env, - `[in] env`: The environment that the API is invoked under. - `[in] async_resource`: An optional object associated with the async work that will be passed to possible `async_hooks` [`init` hooks][]. -- `[in] async_resource_name`: Required identifier for the kind of resource +- `[in] async_resource_name`: Identifier for the kind of resource that is being provided for diagnostic information exposed by the `async_hooks` API. - `[out] result`: The initialized async context. |