Skip to content

Commit 4a6d0ac

Browse files
kthelgasonrvagg
authored andcommitted
doc: update eol handling in readline
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]>
1 parent abb0f6c commit 4a6d0ac

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

doc/api/readline.markdown

+3-2
Original file line numberDiff line numberDiff line change
@@ -118,8 +118,9 @@ the `input` stream receives a `^C`, respectively known as `SIGINT`.
118118

119119
`function (line) {}`
120120

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

124125
Example of listening for `'line'`:
125126

0 commit comments

Comments
 (0)