diff options
| author | Rich Trott <rtrott@gmail.com> | 2020-06-15 00:49:34 +0300 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2020-06-19 18:09:05 +0300 |
| commit | d1d412b413d2f8febb1795459ff04c36c9c87f2c (patch) | |
| tree | feeb2d25788a98693c3bf23975d163a67827091e /doc/api/readline.md | |
| parent | 9918bdf5cb07f58d230522244a372cbb1b510956 (diff) | |
doc: use sentence-case for headings in docs
PR-URL: https://github.com/nodejs/node/pull/33889
Refs: https://developers.google.com/style/capitalization#capitalization-in-titles-and-headings
Refs: https://docs.microsoft.com/en-us/style-guide/capitalization
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/readline.md')
| -rw-r--r-- | doc/api/readline.md | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/api/readline.md b/doc/api/readline.md index 04233f1a591..e20454a6cb3 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -536,7 +536,7 @@ the best compatibility if it defines an `output.columns` property and emits a `'resize'` event on the `output` if or when the columns ever change ([`process.stdout`][] does this automatically when it is a TTY). -### Use of the `completer` Function +### 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: @@ -661,7 +661,7 @@ rl.on('line', (line) => { }); ``` -## Example: Read File Stream Line-by-Line +## Example: Read file stream line-by-Line A common use case for `readline` is to consume an input file one line at a time. The easiest way to do so is leveraging the [`fs.ReadStream`][] API as |