doc: clarify operation of napi_cancel_async_work #12974
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
gibfahn
approved these changes
May 11, 2017
thefourtheye
approved these changes
May 11, 2017
cjihrig
approved these changes
May 11, 2017
Trott
reviewed
May 11, 2017
doc/api/n-api.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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
jasnell
reviewed
May 11, 2017
doc/api/n-api.md
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
either drop 'a' or s/work/work item
Trott
reviewed
May 11, 2017
doc/api/n-api.md
Outdated
| 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. |
There was a problem hiding this comment.
Nit: even when it was successfully cancelled -> even if it has been successfully cancelled?
jasongin
approved these changes
May 12, 2017
jasnell
approved these changes
May 12, 2017
|
Believe I have addressed @Trott 's comments and many approvals so going to land CI Run: https://ci.nodejs.org/job/node-test-pull-request/8090/ |
|
CI good, landing. |
|
Landed as: 1b28022 |
mhdawson
added a commit
that referenced
this pull request
May 16, 2017
PR-URL: #12974 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
anchnk
pushed a commit
to anchnk/node
that referenced
this pull request
May 19, 2017
PR-URL: nodejs#12974 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
3 tasks
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
Apr 10, 2018
PR-URL: nodejs#12974 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
MylesBorins
pushed a commit
that referenced
this pull request
Apr 16, 2018
Backport-PR-URL: #19447 PR-URL: #12974 Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Jason Ginchereau <jasongin@microsoft.com>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc, n-api