diff options
author | James M Snell <jasnell@gmail.com> | 2018-02-05 21:55:16 -0800 |
---|---|---|
committer | Anatoli Papirovski <apapirovski@mac.com> | 2018-02-08 11:57:14 -0500 |
commit | d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa (patch) | |
tree | 643d44f1eb33c9b822fea7742d2691355d295a4c /doc/api/readline.md | |
parent | 809af1fe8a0a096be4f0a3020f8e60ee1c827cbc (diff) | |
download | android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.gz android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.tar.bz2 android-node-v8-d3569b623ccd593c9ef62fcaf0aba2711dc7fbfa.zip |
doc: remove **Note:** tags
Remove the various **Note:** prefixes throughout the docs.
PR-URL: https://github.com/nodejs/node/pull/18592
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Diffstat (limited to 'doc/api/readline.md')
-rw-r--r-- | doc/api/readline.md | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index 42d07da2d0..2e6c9cb07f 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -29,9 +29,9 @@ rl.question('What do you think of Node.js? ', (answer) => { }); ``` -*Note*: Once this code is invoked, the Node.js application will not -terminate until the `readline.Interface` is closed because the interface -waits for data to be received on the `input` stream. +Once this code is invoked, the Node.js application will not terminate until the +`readline.Interface` is closed because the interface waits for data to be +received on the `input` stream. ## Class: Interface <!-- YAML @@ -142,7 +142,7 @@ rl.on('SIGCONT', () => { }); ``` -*Note*: The `'SIGCONT'` event is _not_ supported on Windows. +The `'SIGCONT'` event is _not_ supported on Windows. ### Event: 'SIGINT' <!-- YAML @@ -194,7 +194,7 @@ rl.on('SIGTSTP', () => { }); ``` -*Note*: The `'SIGTSTP'` event is _not_ supported on Windows. +The `'SIGTSTP'` event is _not_ supported on Windows. ### rl.close() <!-- YAML @@ -262,8 +262,8 @@ 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` 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. ### rl.resume() @@ -315,8 +315,8 @@ rl.write('Delete this!'); rl.write(null, { ctrl: true, name: 'u' }); ``` -*Note*: The `rl.write()` method will write the data to the `readline` -Interface's `input` *as if it were provided by the user*. +The `rl.write()` method will write the data to the `readline` Interface's +`input` *as if it were provided by the user*. ## readline.clearLine(stream, dir) <!-- YAML @@ -467,8 +467,8 @@ autocompletion is disabled when copy-pasted input is detected. If the `stream` is a [TTY][], then it must be in raw mode. -*Note*: This is automatically called by any readline instance on its `input` -if the `input` is a terminal. Closing the `readline` instance does not stop +This is automatically called by any readline instance on its `input` if the +`input` is a terminal. Closing the `readline` instance does not stop the `input` from emitting `'keypress'` events. ```js |