Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: clarify operation of napi_cancel_async_work #12974

Closed
wants to merge 3 commits into from
Closed

doc: clarify operation of napi_cancel_async_work #12974

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2f6520e
doc: clarify operation of napi_cancel_async_work
mhdawson May 11, 2017
e156568
squash! spelling nit
gibfahn May 11, 2017
a4ef20a
squash: address comments
mhdawson May 12, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions doc/api/n-api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2931,11 +2931,12 @@ NAPI_EXTERN napi_status napi_cancel_async_work(napi_env env,

Returns `napi_ok` if the API succeeded.

This API cancels a previously allocated work, provided
it has not yet been queued for execution. After this function is called
This API cancels a previously queued work if it has not yet
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: a previously queued work? Should that just be previously queued work without the a?

Nit: previously queued -> previously-queued or (even better IMO) just queued

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

either drop 'a' or s/work/work item

been started. If it has already started executing, it cannot be
cancelled and `napi_generic_failure` will be returned. If successful,
the `complete` callback will be invoked with a status value of
`napi_cancelled`. The work should not be deleted before the `complete`
callback invocation, even when it was cancelled.
callback invocation, even when it was successfully cancelled.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: even when it was successfully cancelled -> even if it has been successfully cancelled?



[Aynchronous Operations]: #n_api_asynchronous_operations
Expand Down