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: add a note about possible missing lines to readline.asyncIterator #34675

Closed
wants to merge 1 commit into from
Closed

doc: add a note about possible missing lines to readline.asyncIterator #34675

wants to merge 1 commit into from

Conversation

mikhalev-im
Copy link
Contributor

@mikhalev-im mikhalev-im commented Aug 8, 2020 •
edited
Loading

Fixes: #33463

Adds a note to the documentation of the readline module that you may miss lines if you have async operations between interface creation and async iteration (since readline is not a stream).

Hopefully I followed the guidelines correctly as this is my first-time contribution.

Checklist

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. labels Aug 8, 2020
@mikhalev-im
Copy link
Contributor Author

Also related to #28565

@Trott
Copy link
Member

Trott commented Aug 10, 2020

@nodejs/readline

@Trott Trott requested review from devsnek and BridgeAR August 23, 2020 11:53
@antsmartian antsmartian added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 26, 2020
@github-actions github-actions bot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 26, 2020
@nodejs-github-bot
Copy link
Collaborator

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

@github-actions github-actions bot mentioned this pull request Aug 27, 2020
Open
10 tasks
@mikhalev-im
Copy link
Contributor Author

Hey guys, I see that some checks failed (not sure why, since only documentation has changed), do I need to act on this somehow?

@Trott
Copy link
Member

Trott commented Aug 29, 2020

I see that some checks failed (not sure why, since only documentation has changed), do I need to act on this somehow?

No, this is a doc-only change and can land as long as the linter and make-doc jobs have passed (which they have).

Trott pushed a commit that referenced this pull request Aug 29, 2020
@mikhalev-im @Trott
doc: add a note about possible missing lines to readline.asyncIterator
33eda80 
Fixes: #33463

PR-URL: #34675
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@Trott
Copy link
Member

Trott commented Aug 29, 2020

Landed in 33eda80.

Thanks for the contribution! 🎉

@Trott Trott closed this Aug 29, 2020
richardlau pushed a commit that referenced this pull request Sep 1, 2020
@mikhalev-im @richardlau
doc: add a note about possible missing lines to readline.asyncIterator
2407a7a 
Fixes: #33463

PR-URL: #34675
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Rich Trott <rtrott@gmail.com>
@richardlau richardlau mentioned this pull request Sep 2, 2020
Merged
4 tasks
richardlau pushed a commit that referenced this pull request Apr 3, 2022
@mikhalev-im @richardlau
doc: add a note about possible missing lines to readline.asyncIterator
333eda8 
Fixes: #33463

PR-URL: #34675
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Rich Trott <rtrott@gmail.com>
This was referenced Apr 3, 2022
Merged
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BridgeAR BridgeAR BridgeAR approved these changes

@devsnek devsnek devsnek approved these changes

@antsmartian antsmartian antsmartian approved these changes

@Trott Trott Trott approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module.
Projects
None yet
Milestone
No milestone
7 participants
@mikhalev-im @Trott @nodejs-github-bot @jasnell @antsmartian @devsnek @BridgeAR