From 5f0c6fc142ed6a96ab2fe8796525a774e7faeaf7 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Tue, 16 Jan 2018 14:05:26 -0500 Subject: [PATCH 1/2] 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 --- doc/api/n-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index b868bb94ba9cc3..79161a5c508ecb 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -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. From 41e89b5d088363ac6fd75526738af7c6955c8b89 Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 17 Jan 2018 18:30:53 -0500 Subject: [PATCH 2/2] squash: address comments --- doc/api/n-api.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 79161a5c508ecb..ecfdbad6dc464f 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.