Skip to content

doc: improve ALS.enterWith and exit descriptions - #36705

Merged
Trott merged 1 commit into
nodejs:masterfrom
puzpuzpuz:enhancement/improve-als-exit-doc
Jan 2, 2021
Merged

doc: improve ALS.enterWith and exit descriptions#36705
Trott merged 1 commit into
nodejs:masterfrom
puzpuzpuz:enhancement/improve-als-exit-doc

Conversation

@puzpuzpuz

@puzpuzpuzpuzpuzpuz commented Dec 31, 2020•
edited
Loading

Copy link
Copy Markdown
Member

Refs: #36683

Aims to add more clarity into ALS' enterWith and exit method docs in order to avoid confusion around their behavior.

Also includes the following:

  • Adds als.enterWith() mentioning in parallel with als.run() where necessary (e.g. in als.disable()'s doc)
  • Updates als.enterWith()'s in a way which is more consistent with other methods' docs
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@puzpuzpuzpuzpuzpuz added doc Issues and PRs related to the documentations. async_hooks Issues and PRs related to the async hooks subsystem. labels Dec 31, 2020
@puzpuzpuz
puzpuzpuzforce-pushed the enhancement/improve-als-exit-doc branch from e412c20 to 830db9dCompareDecember 31, 2020 07:52
@puzpuzpuzpuzpuzpuz mentioned this pull request Dec 31, 2020
Closed
Flarna
Flarna reviewed Jan 1, 2021
View reviewed changes
Comment threaddoc/api/async_hooks.md Outdated
@puzpuzpuzpuzpuzpuz added the request-ci Add this label to start a Jenkins CI on a PR. label Jan 2, 2021
@puzpuzpuz

puzpuzpuz commented Jan 2, 2021

Copy link
Copy Markdown
MemberAuthor

@jasnell@Flarna thanks for your reviews!

@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Jan 2, 2021
@puzpuzpuz@Trott
doc: improve ALS.enterWith and exit descriptions
1b68030
PR-URL: nodejs#36705
Refs: nodejs#36683
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@Trott
Trottforce-pushed the enhancement/improve-als-exit-doc branch from dfd594a to 1b68030CompareJanuary 2, 2021 13:41
@Trott
Trott merged commit 1b68030 into nodejs:masterJan 2, 2021
@Trott

Trott commented Jan 2, 2021

Copy link
Copy Markdown
Member

Landed in 1b68030

danielleadams pushed a commit that referenced this pull request Jan 12, 2021
@puzpuzpuz@danielleadams
doc: improve ALS.enterWith and exit descriptions
181bd05
PR-URL: #36705
Refs: #36683
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@danielleadamsdanielleadams mentioned this pull request Jan 12, 2021
Merged
targos pushed a commit that referenced this pull request May 1, 2021
@puzpuzpuz@targos
doc: improve ALS.enterWith and exit descriptions
97faeeb
PR-URL: #36705
Refs: #36683
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@danielleadamsdanielleadams mentioned this pull request May 3, 2021
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasnelljasnelljasnell approved these changes
@TrottTrottTrott approved these changes
@FlarnaFlarnaFlarna approved these changes

Assignees

No one assigned

Labels

async_hooksIssues and PRs related to the async hooks subsystem.docIssues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@puzpuzpuz@Trott@jasnell@Flarna