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.

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

doc: update readline docs on EOL handling #4927

Closed
wants to merge 1 commit into from

Conversation

kthelgason
Copy link
Contributor

As raised in #4916 readline actually handles all the various forms of EOL (\r, \r\n, \n).

@mscdex mscdex added doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module. labels Jan 28, 2016
@@ -118,7 +118,7 @@ the `input` stream receives a `^C`, respectively known as `SIGINT`.

`function (line) {}`

Emitted whenever the `input` stream receives a `\n`, usually received when the
Emitted whenever the `input` stream receives `EOL`, usually received when the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This could be clearer if we explicitly said "end of line (\n, \r, or \r\n)"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good, will fix.

@cjihrig
Copy link
Contributor

cjihrig commented Jan 28, 2016

LGTM with a suggestion.

@kthelgason
Copy link
Contributor Author

Fixed according to @cjihrig's suggestion.

cjihrig pushed a commit that referenced this pull request Jan 28, 2016
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.

Fixes: #4916
PR-URL: #4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@cjihrig
Copy link
Contributor

cjihrig commented Jan 28, 2016

Thanks! Landed in 3218dfb.

@cjihrig cjihrig closed this Jan 28, 2016
rvagg pushed a commit that referenced this pull request Jan 28, 2016
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.

Fixes: #4916
PR-URL: #4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@jasnell
Copy link
Member

jasnell commented Jan 29, 2016

Added the lts-watch label. Doc updates like this should generally always be on the lts watch list unless they depend on a semver-minor or major.

rvagg pushed a commit that referenced this pull request Feb 8, 2016
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.

Fixes: #4916
PR-URL: #4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 17, 2016
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.

Fixes: #4916
PR-URL: #4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 18, 2016
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.

Fixes: #4916
PR-URL: #4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Feb 18, 2016
MylesBorins pushed a commit that referenced this pull request Mar 2, 2016
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.

Fixes: #4916
PR-URL: #4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
scovetta pushed a commit to scovetta/node that referenced this pull request Apr 2, 2016
This commit explicitly calls out the end of line sequences
used to generate line events in the readline module.

Fixes: nodejs#4916
PR-URL: nodejs#4927
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. readline Issues and PRs related to the built-in readline module.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants