summaryrefslogtreecommitdiff
path: root/doc/api/readline.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2018-02-20 15:10:10 -0800
committerBenjamin Gruenbaum <benji@peer5.com>2018-02-23 02:53:21 +0200
commit9cb96ac82808254e3322119eb1e6b2a7b847741e (patch)
tree7f3be41a7e2e3e28f5b3e87258d5fc37d92829ed /doc/api/readline.md
parent54cb3c5759919745c25554daffc613dbee230d37 (diff)
downloadandroid-node-v8-9cb96ac82808254e3322119eb1e6b2a7b847741e.tar.gz
android-node-v8-9cb96ac82808254e3322119eb1e6b2a7b847741e.tar.bz2
android-node-v8-9cb96ac82808254e3322119eb1e6b2a7b847741e.zip
doc: remove extraneous "for example" text
No need to announce obvious example code as being example code. Remove unneeded "for example" text as one small way to try to keep the docs more concise.. PR-URL: https://github.com/nodejs/node/pull/18890 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
-rw-r--r--doc/api/readline.md14
1 files changed, 0 insertions, 14 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md
index 2e6c9cb07f..69c49b10ea 100644
--- a/doc/api/readline.md
+++ b/doc/api/readline.md
@@ -75,8 +75,6 @@ presses the `<Enter>`, or `<Return>` keys.
The listener function is called with a string containing the single line of
received input.
-For example:
-
```js
rl.on('line', (input) => {
console.log(`Received: ${input}`);
@@ -96,8 +94,6 @@ The `'pause'` event is emitted when one of the following occur:
The listener function is called without passing any arguments.
-For example:
-
```js
rl.on('pause', () => {
console.log('Readline paused.');
@@ -133,8 +129,6 @@ not be emitted.
The listener function is invoked without passing any arguments.
-For example:
-
```js
rl.on('SIGCONT', () => {
// `prompt` will automatically resume the stream
@@ -156,8 +150,6 @@ event will be emitted.
The listener function is invoked without passing any arguments.
-For example:
-
```js
rl.on('SIGINT', () => {
rl.question('Are you sure you want to exit? ', (answer) => {
@@ -184,8 +176,6 @@ paused before the process was sent to the background.
The listener function is invoked without passing any arguments.
-For example:
-
```js
rl.on('SIGTSTP', () => {
// This will override SIGTSTP and prevent the program from going to the
@@ -307,8 +297,6 @@ paused.
If the `readline.Interface` was created with `output` set to `null` or
`undefined` the `data` and `key` are not written.
-For example:
-
```js
rl.write('Delete this!');
// Simulate Ctrl+u to delete the line written previously
@@ -387,8 +375,6 @@ changes:
The `readline.createInterface()` method creates a new `readline.Interface`
instance.
-For example:
-
```js
const readline = require('readline');
const rl = readline.createInterface({