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]>
nodejs · Jan 28, 2016 · 3218dfb · 3218dfb
1 parent b8ae0f7
commit 3218dfb
Showing 1 changed file with 3 additions and 2 deletions.
diff --git a/doc/api/readline.markdown b/doc/api/readline.markdown
@@ -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'`: