FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: clarify operation of napi_cancel_async_work by mhdawson · Pull Request #12974 · nodejs/node · GitHub

/ node Public

doc: clarify operation of napi_cancel_async_work - #12974

Closed
mhdawson wants to merge 3 commits into
nodejs:masterfrom
mhdawson:napi-doc-update1
Closed

doc: clarify operation of napi_cancel_async_work#12974
mhdawson wants to merge 3 commits into
nodejs:masterfrom
mhdawson:napi-doc-update1

Conversation

Copy link
Copy Markdown
Member
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows [commit guidelines]
Affected core subsystem(s)

doc, n-api

nodejs-github-bot added doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API. labels May 11, 2017
Comment thread doc/api/n-api.md Outdated

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
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread doc/api/n-api.md Outdated

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
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread 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.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Copy link
Copy Markdown
Member Author

@Trott, @jasnell thanks for the comments. Commit pushed to address them.

Copy link
Copy Markdown
Member Author

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/

Copy link
Copy Markdown
Member Author

CI good, landing.

Copy link
Copy Markdown
Member Author

Landed as: 1b28022

mhdawson closed this May 16, 2017
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>
jasnell mentioned this pull request May 28, 2017
gibfahn mentioned this pull request Jun 15, 2017
3 tasks
mhdawson deleted the napi-doc-update1 branch June 28, 2017 19:24
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>
MylesBorins mentioned this pull request Apr 16, 2018
This file contains hidden or 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. node-api Issues and PRs related to the Node-API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants


Back | FazBrowse Home | New Git URL