Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for zsh parameter and subcommand description with autocompletion #301

Open
jakobkmar opened this issue Jul 16, 2021 · 1 comment

Comments

@jakobkmar
Copy link

Zsh has support for showing the description of parameters and subcommands.

Example:
image

Can Clikt generate a completion script which shows these helpful descriptions?

@ajalt
Copy link
Owner

ajalt commented Jul 19, 2021

The ZSH completion is implemented using bashcompinit, which doesn't support descriptions AFAIK.

I'd welcome a PR if you want to write a new completion generator that uses the ZSH-native completion APIs. You could look at the FishCompletionGenerator for an example of a generator that includes help descriptions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants