kislyuk / argcomplete

Python and tab completion, better together.
https://kislyuk.github.io/argcomplete/
Apache License 2.0
1.39k stars 129 forks source link

Expand completer protocol to provide descriptions #416

Open kislyuk opened 1 year ago

kislyuk commented 1 year ago

Zsh support currently only supports descriptions from argparse help strings. Expand the completer protocol to optionally emit descriptions (for example, by emitting a completion:description mapping instead of a sequence of completions) and forward them to zsh.

kislyuk commented 1 year ago

Protocol was expanded in 21bf9633bb98e09795b0c1ab383658530745dbab but need to document.