Skip to content

doc: add note about resource type in async_hooks - #41797

Merged
nodejs-github-bot merged 5 commits into
nodejs:masterfrom
tony-go:async-hooks-doc-type
Feb 3, 2022
Merged

doc: add note about resource type in async_hooks#41797
nodejs-github-bot merged 5 commits into
nodejs:masterfrom
tony-go:async-hooks-doc-type

Conversation

@tony-go

Copy link
Copy Markdown
Member

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 @bmeckmentions 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-botnodejs-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

Trott commented Feb 1, 2022

Copy link
Copy Markdown
Member

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-goforce-pushed the async-hooks-doc-type branch from cdbda7b to e1aff5cCompareFebruary 1, 2022 10:12
@tony-go

Copy link
Copy Markdown
MemberAuthor

Thanks for the feedback @Trott 🙌.

Let me know if it's good now.

@RafaelGSSRafaelGSS left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM.

@RafaelGSS

Copy link
Copy Markdown
Member

cc: @Qard

Qard
Qard approved these changes Feb 1, 2022
@TrottTrott changed the title doc: async_hooks - add note about resource typedoc: add note about resource type in async_hooksFeb 1, 2022
Comment threaddoc/api/async_hooks.md Outdated
Comment threaddoc/api/async_hooks.md Outdated
@tony-go
tony-go requested a review from TrottFebruary 1, 2022 20:50
Comment threaddoc/api/async_hooks.md Outdated
Co-authored-by: Rich Trott <rtrott@gmail.com>

@RaisinTenRaisinTen left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM, thanks!

@TrottTrott 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

Trott commented Feb 2, 2022

Copy link
Copy Markdown
Member

@nodejs/async_hooks

Comment threaddoc/api/async_hooks.md Outdated
@FlarnaFlarna 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-botnodejs-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:masterFeb 3, 2022
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Landed in 064783c

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>
@ruyadornoruyadorno mentioned this pull request Feb 8, 2022
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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

async_hooksIssues and PRs related to the async hooks subsystem.author readyPRs that have at least one approval, no pending requests for changes, and a CI started.commit-queue-squashAdd this label to instruct the Commit Queue to squash all the PR commits into the first one.docIssues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants

@tony-go@Trott@RafaelGSS@nodejs-github-bot@Qard@vdeturckheim@Flarna@RaisinTen