diff --git a/doc/api/readline.markdown b/doc/api/readline.markdown index 6aab28679b..055bc39bdf 100644 --- a/doc/api/readline.markdown +++ b/doc/api/readline.markdown @@ -125,6 +125,8 @@ Example usage: Pauses the readline `input` stream, allowing it to be resumed later if needed. +Note that this doesn't immediately pause the stream of events. Several events may be emitted after calling `pause`, including `line`. + ### rl.resume() Resumes the readline `input` stream.