Commit 4a6d0ac
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 <cjihrig@gmail.com>1 parent abb0f6c commit 4a6d0ac
1 file changed
Lines changed: 3 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -118,8 +118,9 @@ the `input` stream receives a `^C`, respectively known as `SIGINT`. | |||
| 118 | 118 | ||
| 119 | 119 | `function (line) {}` | |
| 120 | 120 | ||
| 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. | ||
| 123 | 124 | ||
| 124 | 125 | Example of listening for `'line'`: | |
| 125 | 126 | ||
0 commit comments