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 AsyncLocalStorage sample #32757

Closed
wants to merge 1 commit into from
Closed

doc: improve AsyncLocalStorage sample #32757

wants to merge 1 commit into from

Conversation

puzpuzpuz
Copy link
Member

@puzpuzpuz puzpuzpuz commented Apr 10, 2020 •
edited
Loading

Improves sample snippet in AsyncLocalStorage doc section. Recently I've heard the following complains from one of early adopters of the API:

  • Current snippet can't be run as is (because of the non-existing someAsyncOperation function)
  • Current snippet logs only in on-error case and, in general, could be improved to show a solution for a real-world problem

The update tries to address the above items.

cc @vdeturckheim

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@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 Apr 10, 2020
cjihrig
cjihrig approved these changes Apr 10, 2020
View reviewed changes
doc/api/async_hooks.md Outdated Show resolved Hide resolved
doc/api/async_hooks.md Outdated Show resolved Hide resolved
doc/api/async_hooks.md Outdated Show resolved Hide resolved
@puzpuzpuz puzpuzpuz force-pushed the improve-als-sample branch from 64036ea to ef7f5d0 Compare April 10, 2020 16:43
@puzpuzpuz
Copy link
Member Author

@cjihrig thanks for the suggested changes. I have applied all of them.

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/30628/

@nodejs-github-bot
Copy link
Collaborator

CI: https://ci.nodejs.org/job/node-test-pull-request/30631/

@Flarna Flarna added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 12, 2020
@addaleax
Copy link
Member

Landed in 82d6726

@addaleax addaleax closed this Apr 13, 2020
addaleax pushed a commit that referenced this pull request Apr 13, 2020
@puzpuzpuz @addaleax
doc: improve AsyncLocalStorage sample
82d6726 
PR-URL: #32757
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@puzpuzpuz puzpuzpuz mentioned this pull request Apr 14, 2020
Closed
4 tasks
@puzpuzpuz
Copy link
Member Author

v12.x backport PR: #32318

@puzpuzpuz puzpuzpuz deleted the improve-als-sample branch April 14, 2020 07:52
BethGriggs pushed a commit that referenced this pull request Apr 14, 2020
@puzpuzpuz @BethGriggs
doc: improve AsyncLocalStorage sample
8f7fd8d 
PR-URL: #32757
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@BethGriggs BethGriggs mentioned this pull request Apr 14, 2020
Merged
puzpuzpuz added a commit to puzpuzpuz/node that referenced this pull request Apr 14, 2020
@puzpuzpuz
doc: improve AsyncLocalStorage sample
fce0272 
PR-URL: nodejs#32757
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@targos targos added backported-to-v12.x and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backport-open-v12.x labels Apr 25, 2020
targos pushed a commit to targos/node that referenced this pull request Apr 25, 2020
@puzpuzpuz @targos
doc: improve AsyncLocalStorage sample
9690a53 
PR-URL: nodejs#32757
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
BridgeAR pushed a commit that referenced this pull request Apr 28, 2020
@puzpuzpuz @BridgeAR
doc: improve AsyncLocalStorage sample
c0e4ac4 
PR-URL: #32757
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@BridgeAR BridgeAR mentioned this pull request Apr 28, 2020
Merged
targos pushed a commit that referenced this pull request Apr 28, 2020
@puzpuzpuz @targos
doc: improve AsyncLocalStorage sample
e8985c2 
PR-URL: #32757
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Gerhard Stöbich <deb2001-github@yahoo.de>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@targos targos mentioned this pull request May 2, 2020
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

@legendecas legendecas legendecas approved these changes

@cjihrig cjihrig cjihrig approved these changes

@targos targos targos approved these changes

@lpinca lpinca lpinca 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.
8 participants
@puzpuzpuz @nodejs-github-bot @addaleax @lpinca @targos @cjihrig @legendecas @Flarna