Skip to content

Commit

Permalink
Note completers can return iterables of strings, not just lists (#422)
Browse files Browse the repository at this point in the history
Some of the built in implementations actually do that already.
  • Loading branch information
scop authored Apr 8, 2023
1 parent ecb3b47 commit cbfb8da
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ readline-style. Callable completers are simpler. They are called with the follow
* ``parsed_args``: The result of argument parsing so far (the ``argparse.Namespace`` args object normally returned by
``ArgumentParser.parse_args()``).

Completers can return their completions as a sequence (list) of strings or a mapping (dict) of strings to their
Completers can return their completions as an iterable of strings or a mapping (dict) of strings to their
descriptions (zsh will display the descriptions as context help alongside completions). An example completer for names
of environment variables might look like this:

Expand Down

0 comments on commit cbfb8da

Please sign in to comment.