diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-10-24 07:28:42 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-10-26 18:39:41 +0300 |
| commit | 10040500da6af33b602e35c3f3bbe28cf76c4c4a (patch) | |
| tree | 69c2af94709de9ef7022c41423c0f618eb0d5e0a /doc/api/tty.md | |
| parent | 6858c7e3e7c30986d68a683d3d5e4ede4c0b529f (diff) | |
doc: remove dashes
The use of dashes -- in general, but especially in our docs -- can be
problematic. It is used inconsistently and there is always another form
of punctuation that is as good or better for the situation. In an effort
to reduce the number of variations we use to display the same types of
information, remove the various uses of dashes from the documentation.
PR-URL: https://github.com/nodejs/node/pull/30101
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/tty.md')
| -rw-r--r-- | doc/api/tty.md | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/api/tty.md b/doc/api/tty.md index 2f8e1de587c..186a236b57f 100644 --- a/doc/api/tty.md +++ b/doc/api/tty.md @@ -65,7 +65,7 @@ added: v0.7.7 raw device. If `false`, configures the `tty.ReadStream` to operate in its default mode. The `readStream.isRaw` property will be set to the resulting mode. -* Returns: {this} - the read stream instance. +* Returns: {this} The read stream instance. Allows configuration of `tty.ReadStream` so that it operates as a raw device. @@ -112,9 +112,9 @@ changes: --> * `dir` {number} - * `-1` - to the left from cursor - * `1` - to the right from cursor - * `0` - the entire line + * `-1`: to the left from cursor + * `1`: to the right from cursor + * `0`: the entire line * `callback` {Function} Invoked once the operation completes. * Returns: {boolean} `false` if the stream wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional |