Skip to content

Commit

Permalink
doc: fix an unclear wording in readline.md
Browse files Browse the repository at this point in the history
PR-URL: #12605
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
  • Loading branch information
vsemozhetbyt authored and MylesBorins committed May 18, 2017
1 parent ce795ec commit 5ce1089
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions doc/api/readline.md
Original file line number Diff line number Diff line change
Expand Up @@ -396,8 +396,8 @@ a `'resize'` event on the `output` if or when the columns ever change

### Use of the `completer` Function

When called, the `completer` function is provided the current line entered by
the user, and is expected to return an Array with 2 entries:
The `completer` function takes the current line entered by the user
as an argument, and returns an Array with 2 entries:

* An Array with matching entries for the completion.
* The substring that was used for the matching.
Expand Down

0 comments on commit 5ce1089

Please sign in to comment.