Skip to content
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: add entry for AsyncHook class #31865

Closed
wants to merge 4 commits into from

Conversation

HarshithaKP
Copy link
Member

fixes: #31661

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added async_hooks Issues and PRs related to the async hooks subsystem. doc Issues and PRs related to the documentations. labels Feb 19, 2020
doc/api/async_hooks.md Outdated Show resolved Hide resolved
doc/api/async_hooks.md Outdated Show resolved Hide resolved

The class `AsyncHook` exposes interface for tracking lifetime events
of asynchronous operations. Using a unique ID per asynchronous call,
it helps associating method calls that otherwise do not appear together
Copy link
Member

Choose a reason for hiding this comment

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

Either

Suggested change
it helps associating method calls that otherwise do not appear together
it helps with associating method calls that otherwise do not appear together

or

Suggested change
it helps associating method calls that otherwise do not appear together
it helps associate method calls that otherwise do not appear together

That being said – what’s a typical call stack?

Copy link
Member Author

Choose a reason for hiding this comment

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

@addaleax , I used typical here to mean a representative call stack on node.js program error. As per my understanding, a representative stack is a incomplete part of an asynchronous sequence. Am I wrong?

Copy link
Member

Choose a reason for hiding this comment

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

@HarshithaKP I’m still confused… That kind of only moves the question from “what’s a typical call stack?” to “what’s a representative call stack?”.

To be honest, I think it’s okay to drop the second sentence here. The sentence is not accurate anyway, the IDs are unique per asynchronous resource but not per asynchronous call.

Copy link
Member Author

Choose a reason for hiding this comment

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

@addaleax, dropped the second sentence.

@Trott
Copy link
Member

Trott commented Feb 21, 2020

@nodejs/documentation

(I'm feeling @vsemozhetbyt's absence these days. ❤️)

@gireeshpunathil
Copy link
Member

@gireeshpunathil gireeshpunathil added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 5, 2020
@addaleax addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 9, 2020
@BridgeAR BridgeAR added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Mar 9, 2020
addaleax pushed a commit that referenced this pull request Mar 11, 2020
fixes: #31661

PR-URL: #31865
Fixes: #31661
Reviewed-By: Stephen Belanger <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@addaleax
Copy link
Member

Landed in e4a72d6

@addaleax addaleax closed this Mar 11, 2020
MylesBorins pushed a commit that referenced this pull request Mar 11, 2020
fixes: #31661

PR-URL: #31865
Fixes: #31661
Reviewed-By: Stephen Belanger <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: James M Snell <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Mar 12, 2020
targos pushed a commit that referenced this pull request Apr 22, 2020
fixes: #31661

PR-URL: #31865
Fixes: #31661
Reviewed-By: Stephen Belanger <[email protected]>
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Ruben Bridgewater <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
async_hooks Issues and PRs related to the async hooks subsystem. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

async_hooks doc missing AsyncHook class
8 participants