Skip to content

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

Closed
mikhalev-im wants to merge 1 commit into
nodejs:masterfrom
mikhalev-im:docs-readline-async-iterator-missing-lines
Closed

doc: add a note about possible missing lines to readline.asyncIterator#34675
mikhalev-im wants to merge 1 commit into
nodejs:masterfrom
mikhalev-im:docs-readline-async-iterator-missing-lines

Conversation

@mikhalev-im

@mikhalev-immikhalev-im commented Aug 8, 2020

Copy link
Copy Markdown
Contributor

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-botnodejs-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
Copy Markdown
ContributorAuthor

Also related to #28565

@Trott

Copy link
Copy Markdown
Member

@nodejs/readline

@Trott
Trott requested review from BridgeAR and devsnekAugust 23, 2020 11:53
@antsmartianantsmartian added the request-ci Add this label to start a Jenkins CI on a PR. label Aug 26, 2020
@github-actionsgithub-actionsBot removed the request-ci Add this label to start a Jenkins CI on a PR. label Aug 26, 2020
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

@mikhalev-im

Copy link
Copy Markdown
ContributorAuthor

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
Copy Markdown
Member

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
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
Copy Markdown
Member

Landed in 33eda80.

Thanks for the contribution! 🎉

@TrottTrott closed this Aug 29, 2020
richardlau pushed a commit that referenced this pull request Sep 1, 2020
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>
@richardlaurichardlau mentioned this pull request Sep 2, 2020
4 tasks
richardlau pushed a commit that referenced this pull request Apr 3, 2022
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>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docIssues and PRs related to the documentations.readlineIssues and PRs related to the built-in readline module.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

awaiting between creating a readline interface, and using async iterator will cause iterator to sometimes skip.

7 participants

@mikhalev-im@Trott@nodejs-github-bot@jasnell@antsmartian@devsnek@BridgeAR