-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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.
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: fix wording in napi_async_init #49180
doc: fix wording in napi_async_init #49180
Conversation
Review requested:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The grammatical fix is LGTM.
@@ -5633,7 +5633,7 @@ problems like loss of async context when using the `AsyncLocalStorage` API. | |||
|
|||
In order to retain ABI compatibility with previous versions, passing `NULL` | |||
for `async_resource` does not result in an error. However, this is not | |||
recommended as this will result poor results with `async_hooks` | |||
recommended as this will result in undesirable behavior with `async_hooks` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I found that in #32930, NULL
is coerced to a newly created strong-referenced object to avoid breaking async_hooks.executionAsyncResource()
. So it is not breaking async_hooks.executionAsyncResource()
and AsyncLocalStorage
, with the reason mentioned in the paragraph above.
As async_hooks.executionAsyncResource()
is guaranteed to return a non-null object, it might be sufficient to state it is undefined behavior if the async_resource
is NULL
with the semantic conflicts.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Landed in c4bbf0a |
Refs: nodejs/node#32930 PR-URL: nodejs/node#49180 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Refs: nodejs/node#32930 PR-URL: nodejs/node#49180 Reviewed-By: Chengzhong Wu <legendecas@gmail.com> Reviewed-By: Michael Dawson <midawson@redhat.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Even after reading through #32930, I am not quite sure what this was supposed to say, so please feel free to suggest alternatives. cc @legendecas @mhdawson