Skip to content

Commit 643b581

Browse files
kthelgasonMyles Borins
authored and
Myles Borins
committed
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 1afa350 commit 643b581

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
@@ -112,8 +112,9 @@ the `input` stream receives a `^C`, respectively known as `SIGINT`.
112112

113113
`function (line) {}`
114114

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

118119
Example of listening for `'line'`:
119120

0 commit comments

Comments
 (0)