Skip to content

doc: update readline docs on EOL handling #4927

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

Closed
kthelgason wants to merge 1 commit into from
Closed

doc: update readline docs on EOL handling #4927

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions doc/api/readline.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,9 @@ the `input` stream receives a `^C`, respectively known as `SIGINT`.

`function (line) {}`

Emitted whenever the `input` stream receives a `\n`, usually received when the
user hits enter, or return. This is a good hook to listen for user input.
Emitted whenever the `input` stream receives end of line (`\n`, `\r`, or `\r\n`),
usually received when the user hits enter, or return.
This is a good hook to listen for user input.

Example of listening for `'line'`:

Expand Down