summaryrefslogtreecommitdiff
path: root/examples
diff options
context:
space:
mode:
authorNicholas Wiles <nwiles@google.com>2017-10-09 18:00:53 -0700
committerDavid Lord <davidism@gmail.com>2018-05-18 09:09:14 -0700
commit6c7276b5db80dff9310f6b76dd9fac985eb4a246 (patch)
treefb9c720fdf3f7171dc8878a146e74b961dace8d3 /examples
parentbefb77bfe4b814687d9bd8e15c59ae64f579967c (diff)
downloadclick-6c7276b5db80dff9310f6b76dd9fac985eb4a246.tar.gz
support descriptions for zsh completions
use associative array for zsh completion response add documentation for completion help strings fix missing short_help on commands that broke ZSH auto documentation
Diffstat (limited to 'examples')
-rw-r--r--examples/bashcompletion/bashcompletion.py6
1 files changed, 3 insertions, 3 deletions
diff --git a/examples/bashcompletion/bashcompletion.py b/examples/bashcompletion/bashcompletion.py
index c483d79..4d9fdde 100644
--- a/examples/bashcompletion/bashcompletion.py
+++ b/examples/bashcompletion/bashcompletion.py
@@ -13,14 +13,14 @@ def get_env_vars(ctx, args, incomplete):
yield key
-@cli.command()
+@cli.command(help='A command to print environment variables')
@click.argument("envvar", type=click.STRING, autocompletion=get_env_vars)
def cmd1(envvar):
click.echo('Environment variable: %s' % envvar)
click.echo('Value: %s' % os.environ[envvar])
-@click.group()
+@click.group(help='A group that holds a subcommand')
def group():
pass
@@ -33,7 +33,7 @@ def list_users(ctx, args, incomplete):
yield user
-@group.command()
+@group.command(help='Choose a user')
@click.argument("user", type=click.STRING, autocompletion=list_users)
def subcmd(user):
click.echo('Chosen user is %s' % user)