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: update events API example to have runnable code #45755

Closed
bnb opened this issue Dec 6, 2022 · 4 comments · Fixed by #45760
Closed

doc: update events API example to have runnable code #45755

bnb opened this issue Dec 6, 2022 · 4 comments · Fixed by #45760
Labels
doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. good first issue Issues that are suitable for first-time contributors.

Comments

@bnb
Copy link
Contributor

bnb commented Dec 6, 2022 •
edited

Making an issue from my comment in #45656. The code example in that PR should be updated to be runnable. There's an example in my comment that shows a working/runnable code example. Ideally, it'd also have both CJS and ESM examples.
@bnb bnb changed the title doc: update code example to have runnable code doc: update events API example to have runnable code Dec 6, 2022
@bnb bnb added doc Issues and PRs related to the documentations. good first issue Issues that are suitable for first-time contributors. events Issues and PRs related to the events subsystem / EventEmitter. labels Dec 6, 2022
@deokjinkim
Copy link
Contributor

deokjinkim commented Dec 6, 2022 •
edited

@bnb Can I work on this?

deokjinkim added a commit to deokjinkim/node that referenced this issue Dec 6, 2022
@deokjinkim
doc: update events API example to have runnable code
0d99c71 
Fixes: nodejs#45755
@deokjinkim deokjinkim mentioned this issue Dec 6, 2022
Merged
@bnb
Copy link
Contributor Author

bnb commented Dec 6, 2022

@deokjinkim yep! I see you've made a PR, thank you! I'll review it now.

@ashutosh887
Copy link

@bnb Is it resolved?
I would like to work on this Issue!

@bnb
Copy link
Contributor Author

bnb commented Dec 23, 2022

@ashutosh887 it does seem like this one has a PR that can land, but there's plenty of other Docs changes that could land. I'd recommend choosing a Docs page and either look for a missing code example or one that's not independently runnable 😊

nodejs-github-bot pushed a commit that referenced this issue Jan 18, 2023
@deokjinkim
doc: update events API example to have runnable code
4b737c3 
Fixes: #45755
PR-URL: #45760
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
RafaelGSS pushed a commit that referenced this issue Jan 20, 2023
@deokjinkim @RafaelGSS
doc: update events API example to have runnable code
58b836f 
Fixes: #45755
PR-URL: #45760
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
juanarbol pushed a commit that referenced this issue Jan 26, 2023
@deokjinkim @juanarbol
doc: update events API example to have runnable code
c3dcb94 
Fixes: #45755
PR-URL: #45760
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
juanarbol pushed a commit that referenced this issue Jan 31, 2023
@deokjinkim @juanarbol
doc: update events API example to have runnable code
6317502 
Fixes: #45755
PR-URL: #45760
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Tierney Cyren <hello@bnb.im>
Reviewed-By: James M Snell <jasnell@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. events Issues and PRs related to the events subsystem / EventEmitter. good first issue Issues that are suitable for first-time contributors.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

doc: update events API example to have runnable code deokjinkim/node
3 participants
@bnb @deokjinkim @ashutosh887