Skip to content

Commit cbfb8da

Browse files
authored
Note completers can return iterables of strings, not just lists (#422)
Some of the built in implementations actually do that already.
1 parent ecb3b47 commit cbfb8da

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ readline-style. Callable completers are simpler. They are called with the follow
8282
* ``parsed_args``: The result of argument parsing so far (the ``argparse.Namespace`` args object normally returned by
8383
``ArgumentParser.parse_args()``).
8484

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

0 commit comments

Comments
 (0)