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 note about resource type in async_hooks #41797

Merged
merged 5 commits into from
Feb 3, 2022

Conversation

tony-go
Copy link
Member

@tony-go tony-go commented Jan 31, 2022

Hi everyone 👋

During the last Diagnostic WG meeting, the question has been raised of the type argument interface (async_hooks / init hook).

The initial demand was to document more precisely each type. But @bmeck mentions that this list of identifiers described in the documentation could arbitrarily change.

So, this pull request contains a note to explicitly tell users what is the status of these identifiers.

CC @RafaelGSS / @gireeshpunathil

@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 Jan 31, 2022
@Trott
Copy link
Member

Trott commented Feb 1, 2022

Welcome @tony-go and thanks for the pull request. Are you able to edit the first commit message? The first word after doc: should be a verb so perhaps this? doc: add note about resource type

@tony-go tony-go force-pushed the async-hooks-doc-type branch from cdbda7b to e1aff5c Compare February 1, 2022 10:12
@tony-go
Copy link
Member Author

tony-go commented Feb 1, 2022

Thanks for the feedback @Trott 🙌.

Let me know if it's good now.

Copy link
Member

@RafaelGSS RafaelGSS left a comment

Choose a reason for hiding this comment

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

LGTM.

@RafaelGSS
Copy link
Member

cc: @Qard

@Trott Trott changed the title doc: async_hooks - add note about resource type doc: add note about resource type in async_hooks Feb 1, 2022
doc/api/async_hooks.md Outdated Show resolved Hide resolved
doc/api/async_hooks.md Outdated Show resolved Hide resolved
@tony-go tony-go requested a review from Trott February 1, 2022 20:50
doc/api/async_hooks.md Outdated Show resolved Hide resolved
Co-authored-by: Rich Trott <rtrott@gmail.com>
Copy link
Contributor

@RaisinTen RaisinTen left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Feb 2, 2022
@Trott
Copy link
Member

Trott commented Feb 2, 2022

@nodejs/async_hooks

doc/api/async_hooks.md Outdated Show resolved Hide resolved
@Flarna Flarna added commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. commit-queue Add this label to land a pull request using GitHub Actions. labels Feb 3, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Feb 3, 2022
@nodejs-github-bot nodejs-github-bot merged commit 064783c into nodejs:master Feb 3, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in 064783c

VoltrexKeyva pushed a commit to VoltrexKeyva/node that referenced this pull request Feb 3, 2022
PR-URL: nodejs#41797
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
ruyadorno pushed a commit that referenced this pull request Feb 8, 2022
PR-URL: #41797
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
danielleadams pushed a commit that referenced this pull request Mar 2, 2022
PR-URL: #41797
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
danielleadams pushed a commit that referenced this pull request Mar 3, 2022
PR-URL: #41797
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
danielleadams pushed a commit that referenced this pull request Mar 14, 2022
PR-URL: #41797
Reviewed-By: Stephen Belanger <admin@stephenbelanger.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Vladimir de Turckheim <vlad2t@hotmail.com>
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. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants