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

Remove outdated AsyncWrap docs #132

Merged
merged 3 commits into from
Dec 14, 2017
Merged

Conversation

watson
Copy link
Member

@watson watson commented Dec 13, 2017

Since the AsyncHooks docs are now online, I can't think of a reason for the Diagnostics WG to maintain this documentation any more. As discussed in todays meeting I'm therefore making this PR to remove the old AsyncWrap docs from the repo.

The official docs can be found here:
https://nodejs.org/api/async_hooks.html

@AndreasMadsen: This PR is just a suggestion. Just let me know if you think we should do something else 😃

Since the AsyncHooks docs are now online, there's no reason for the
Diagnostics WG to maintain this documentation any more.

The official docs can be found here:
https://nodejs.org/api/async_hooks.html
@watson watson requested a review from AndreasMadsen December 13, 2017 22:09
@AndreasMadsen
Copy link
Member

Hehe, agreed. But we should update https://github.com/nodejs/diagnostics/blob/master/tracing/README.md too.

mhdawson

This comment was marked as off-topic.

@watson
Copy link
Member Author

watson commented Dec 13, 2017

@AndreasMadsen should I update (and rename) the AsyncWrap section in the tracing README.md or do you want me to just remove it completely?

I think it would be nice to have something still as it's a module that falls under our area. I can try and update this PR with a suggestion

@watson
Copy link
Member Author

watson commented Dec 13, 2017

@AndreasMadsen For starters, I just made a minimal change to the tracing README.md now. I'm not sure if the actual text needs changing as well

@AndreasMadsen
Copy link
Member

Maybe just:

AsyncHooks - Tracks the lifetime of asynconuse requests (init/destroy) and their callback activity (before/after).

We now track more than just the AsyncWrap C++ classes. In particular we allow node modules to use the Embedder API to make pools look correct (like setTimeout does).

@watson
Copy link
Member Author

watson commented Dec 14, 2017

@AndreasMadsen fixed

@AndreasMadsen AndreasMadsen merged commit 1e7daf3 into nodejs:master Dec 14, 2017
@watson watson deleted the asyncwrap branch December 14, 2017 15:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants