doc: clarify rl.question callback args

jasnell · jasnell · commit c300ba22128c · 2016-06-07T07:15:14.000-07:00
Clarify that readline's rl.question() callback does not use the err back pattern. Fixes: #4833 PR-URL: #7022 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com>
diff --git a/doc/api/readline.md b/doc/api/readline.md
@@ -262,6 +262,10 @@ rl.question('What is your favorite food?', (answer) => {
 });
 ```
 
+*Note*: The `callback` function passed to `rl.question()` does not follow the
+typical pattern of accepting an `Error` object or `null` as the first argument.
+The `callback` is called with the provided answer as the only argument.git 
+
 ### rl.resume()
 <!-- YAML
 added: v0.3.4
