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.

Sign up for GitHub

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

Jump to bottom

doc: improve ALS.enterWith and exit descriptions #36705

Merged
merged 1 commit into from
Jan 2, 2021
Merged

doc: improve ALS.enterWith and exit descriptions #36705

merged 1 commit into from
Jan 2, 2021

Conversation

puzpuzpuz
Copy link
Member

@puzpuzpuz puzpuzpuz commented Dec 31, 2020 •
edited
Loading

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

@puzpuzpuz puzpuzpuz 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 puzpuzpuz force-pushed the enhancement/improve-als-exit-doc branch from e412c20 to 830db9d Compare December 31, 2020 07:52
@puzpuzpuz puzpuzpuz mentioned this pull request Dec 31, 2020
Open
Flarna
Flarna reviewed Jan 1, 2021
View reviewed changes
doc/api/async_hooks.md Outdated Show resolved Hide resolved
@puzpuzpuz puzpuzpuz added the request-ci Add this label to start a Jenkins CI on a PR. label Jan 2, 2021
@puzpuzpuz
Copy link
Member Author

@jasnell @Flarna thanks for your reviews!

@github-actions github-actions bot 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 Trott force-pushed the enhancement/improve-als-exit-doc branch from dfd594a to 1b68030 Compare January 2, 2021 13:41
@Trott Trott merged commit 1b68030 into nodejs:master Jan 2, 2021
@Trott
Copy link
Member

Trott commented Jan 2, 2021

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>
@danielleadams danielleadams 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>
@danielleadams danielleadams mentioned this pull request May 3, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Flarna Flarna Flarna approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
async_hooks Issues and PRs related to the async hooks subsystem. doc Issues 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