diff options
| author | Michael Dawson <michael_dawson@ca.ibm.com> | 2018-01-16 14:05:26 -0500 |
|---|---|---|
| committer | Michael Dawson <michael_dawson@ca.ibm.com> | 2018-01-18 10:45:46 -0500 |
| commit | f054855bbf15201487f4a7fdac8812c958330af1 (patch) | |
| tree | 64d00dc06f10057df79430d26b390a9750d2a0db /doc/api/n-api.md | |
| parent | f2e62b52385ff5e778d997ba86db70975e5670c7 (diff) | |
| download | android-node-v8-f054855bbf15201487f4a7fdac8812c958330af1.tar.gz android-node-v8-f054855bbf15201487f4a7fdac8812c958330af1.tar.bz2 android-node-v8-f054855bbf15201487f4a7fdac8812c958330af1.zip | |
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
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 3e32ce0701..05e799cc0e 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -3268,7 +3268,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. @@ -3367,7 +3367,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. |