diff options
| author | Nick Schonning <nschonni@gmail.com> | 2019-10-10 01:49:08 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-10-11 08:15:58 +0300 |
| commit | 81bc7b3ba5a37a5ad4de0f8798eb42e631d55617 (patch) | |
| tree | 151d163358f029f8f686b595db2c565ddcff1070 /doc/api/readline.md | |
| parent | a1e47d7603b1d0bf54c8aad027298e964b8c8af4 (diff) | |
doc: escape brackets not used as markdown reference links
These can turn into links if reference links are added to the document
PR-URL: https://github.com/nodejs/node/pull/29809
Reviewed-By: Rich Trott <rtrott@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
| -rw-r--r-- | doc/api/readline.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index 03fdc441723..642272e401e 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -212,7 +212,7 @@ later if necessary. Calling `rl.pause()` does not immediately pause other events (including `'line'`) from being emitted by the `readline.Interface` instance. -### rl.prompt([preserveCursor]) +### rl.prompt(\[preserveCursor\]) <!-- YAML added: v0.1.98 --> @@ -279,7 +279,7 @@ added: v0.1.98 The `rl.setPrompt()` method sets the prompt that will be written to `output` whenever `rl.prompt()` is called. -### rl.write(data[, key]) +### rl.write(data\[, key\]) <!-- YAML added: v0.1.98 --> @@ -349,7 +349,7 @@ async function processLineByLine() { } ``` -## readline.clearLine(stream, dir[, callback]) +## readline.clearLine(stream, dir\[, callback\]) <!-- YAML added: v0.7.7 changes: @@ -371,7 +371,7 @@ changes: The `readline.clearLine()` method clears current line of given [TTY][] stream in a specified direction identified by `dir`. -## readline.clearScreenDown(stream[, callback]) +## readline.clearScreenDown(stream\[, callback\]) <!-- YAML added: v0.7.7 changes: @@ -490,7 +490,7 @@ function completer(linePartial, callback) { } ``` -## readline.cursorTo(stream, x[, y][, callback]) +## readline.cursorTo(stream, x\[, y\]\[, callback\]) <!-- YAML added: v0.7.7 changes: @@ -510,7 +510,7 @@ changes: The `readline.cursorTo()` method moves cursor to the specified position in a given [TTY][] `stream`. -## readline.emitKeypressEvents(stream[, interface]) +## readline.emitKeypressEvents(stream\[, interface\]) <!-- YAML added: v0.7.7 --> @@ -536,7 +536,7 @@ if (process.stdin.isTTY) process.stdin.setRawMode(true); ``` -## readline.moveCursor(stream, dx, dy[, callback]) +## readline.moveCursor(stream, dx, dy\[, callback\]) <!-- YAML added: v0.7.7 changes: |