doc,async_hooks: simplify async_hooks overview #31660
Merged
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
async_hooks
Trott
changed the title
cjihrig
approved these changes
Feb 6, 2020
BridgeAR
approved these changes
Feb 6, 2020
BridgeAR
added
the
author ready
|
To be honest, I don’t think this improves the documentation … I do feel like it makes sense to give examples of which asynchronous resources call their callback multiple times, to clarify that there are conceptually different types of async resources that are not explicitly differentiated by async_hooks but that consumers may still want to treat differently. |
jasnell
reviewed
Feb 7, 2020
|
I have to agree with @addaleax. While the existing text here isn't great, I don't think the proposal is an improvement. |
Trott
removed
the
author ready
Trott
force-pushed
the
async-hooks-overview
branch
from
9174c5f to
5708180
Compare
|
@addaleax @jasnell I've removed the changes that you commented on. The remaining change is very small, but if we all agree it's an improvement (however small), then great. And if not, I'll probably close this and maybe come back to it at a later date. I do think the async_hooks documentation is calling out to be improved, but yeah, please stop me from making it worse. :-D |
jasnell
approved these changes
Feb 7, 2020
Trott
added
the
author ready
Explain the purpose of async_hooks simply in the overview. PR-URL: nodejs#31660 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Trott
force-pushed
the
async-hooks-overview
branch
from
5708180 to
7cbec42
Compare
|
Landed in 7cbec42 |
codebytere
pushed a commit
that referenced
this pull request
Feb 17, 2020
Explain the purpose of async_hooks simply in the overview. PR-URL: #31660 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
codebytere
pushed a commit
that referenced
this pull request
Mar 15, 2020
Explain the purpose of async_hooks simply in the overview. PR-URL: #31660 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
codebytere
pushed a commit
that referenced
this pull request
Mar 17, 2020
Explain the purpose of async_hooks simply in the overview. PR-URL: #31660 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
Merged
codebytere
pushed a commit
that referenced
this pull request
Mar 30, 2020
Explain the purpose of async_hooks simply in the overview. PR-URL: #31660 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com>
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.
The text defining asynchronous resource goes into somewhat laborious
detail to say, basically, that a callback may be called any number of
times. This change makes the text more direct.
Explain the purpose of async_hooks simply in the overview.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes