doc: add call-once note to napi_queue_async_work #27582
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
gabrielschulhof
force-pushed
the
n-api-doc-queue-async-work-once
branch
from
edfae0a
to
5c51956
Compare
cjihrig
approved these changes
May 6, 2019
Trott
reviewed
May 6, 2019
doc/api/n-api.md
Outdated
| @@ -4060,7 +4060,8 @@ napi_status napi_queue_async_work(napi_env env, | |||
| Returns `napi_ok` if the API succeeded. | |||
|
|
|||
| This API requests that the previously allocated work be scheduled | |||
| for execution. | |||
| for execution. Once it returns successfully, this API **must not be called again | |||
There was a problem hiding this comment.
Micro-nit/question: Is "successfully" necessary here?
There was a problem hiding this comment.
I'm always a fan of leaving off the bold/italics/etc. Not blocking, but suggesting.
There was a problem hiding this comment.
"must not be called again" might stand some clarification? Like, will it throw? Or fail silently? Or result in a behavior that is undefined?
There was a problem hiding this comment.
Last nit:
Suggested change
| for execution. Once it returns successfully, this API **must not be called again | |
| for execution. Once it returns, do not call the API with the same | |
| `_napi_async_work` item again. |
There was a problem hiding this comment.
@Trott My understanding was that our style was to avoid addressing the reader. "do not call" is another way of saying "you", isn't it?
Trott
approved these changes
May 6, 2019
lpinca
approved these changes
May 6, 2019
fhinkel
approved these changes
May 9, 2019
Trott
added
the
author ready
Add note to `napi_queue_async_work()` indicating that, upon successful return, it must not be called again with the same work item. Fixes: nodejs#27217 PR-URL: nodejs#27582
gabrielschulhof
force-pushed
the
n-api-doc-queue-async-work-once
branch
from
5c51956
to
2838ab4
Compare
BridgeAR
approved these changes
May 13, 2019
|
Landed in 6be5c3b. |
gabrielschulhof
pushed a commit
to gabrielschulhof/node
that referenced
this pull request
May 13, 2019
Add note to `napi_queue_async_work()` indicating that, upon successful return, it must not be called again with the same work item. Fixes: nodejs#27217 PR-URL: nodejs#27582 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos
pushed a commit
that referenced
this pull request
May 14, 2019
Add note to `napi_queue_async_work()` indicating that, upon successful return, it must not be called again with the same work item. Fixes: #27217 PR-URL: #27582 Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
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.
Add note to
napi_queue_async_work()indicating that, upon successfulreturn, it must not be called again with the same work item.
Fixes: #27217
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes