Skip to content

Commit

Permalink
doc: update eol handling in readline
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
kthelgason authored and rvagg committed Feb 8, 2016
1 parent abb0f6c commit 4a6d0ac
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions doc/api/readline.markdown
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 an 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

0 comments on commit 4a6d0ac

Please sign in to comment.