summaryrefslogtreecommitdiff
path: root/doc/api/readline.md
diff options
context:
space:
mode:
authorVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-04-29 20:46:41 +0300
committerVse Mozhet Byt <vsemozhetbyt@gmail.com>2018-05-03 02:12:07 +0300
commit7588ceaf353af0f257d4d832bace4600edac704e (patch)
treecd01b69085d5c1134c43e61d8acc84586d1a188d /doc/api/readline.md
parentbdf5be98dd901f6c312938198439dbda0b20d517 (diff)
downloadandroid-node-v8-7588ceaf353af0f257d4d832bace4600edac704e.tar.gz
android-node-v8-7588ceaf353af0f257d4d832bace4600edac704e.tar.bz2
android-node-v8-7588ceaf353af0f257d4d832bace4600edac704e.zip
doc: add more missing backticks
Also, fix some other nits in passing (formatting, punctuation, typos, redundancy, obsoleteness). PR-URL: https://github.com/nodejs/node/pull/20438 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
-rw-r--r--doc/api/readline.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md
index ead469e97c..a2a4adf309 100644
--- a/doc/api/readline.md
+++ b/doc/api/readline.md
@@ -303,7 +303,7 @@ rl.write('Delete this!');
rl.write(null, { ctrl: true, name: 'u' });
```
-The `rl.write()` method will write the data to the `readline` Interface's
+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)
@@ -401,9 +401,9 @@ a `'resize'` event on the `output` if or when the columns ever change
### Use of the `completer` Function
The `completer` function takes the current line entered by the user
-as an argument, and returns an Array with 2 entries:
+as an argument, and returns an `Array` with 2 entries:
-* An Array with matching entries for the completion.
+* An `Array` with matching entries for the completion.
* The substring that was used for the matching.
For instance: `[[substr1, substr2, ...], originalsubstring]`.
@@ -447,7 +447,7 @@ added: v0.7.7
* `interface` {readline.Interface}
The `readline.emitKeypressEvents()` method causes the given [Readable][]
-`stream` to begin emitting `'keypress'` events corresponding to received input.
+stream to begin emitting `'keypress'` events corresponding to received input.
Optionally, `interface` specifies a `readline.Interface` instance for which
autocompletion is disabled when copy-pasted input is detected.