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/readline.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/readline.md')
-rw-r--r-- | doc/api/readline.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index 642272e401e..ceda170bc2b 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -360,9 +360,9 @@ changes: * `stream` {stream.Writable} * `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 `stream` wishes for the calling code to wait for the `'drain'` event to be emitted before continuing to write additional data; |