Skip to content

Add help to argument parameter #2983

@Rowlando13

Description

@Rowlando13

We are now open to a PR for adding a help kwarg to arguments in the same way that there is for options and adjusting the help pages to account for this.

Help Pages

@click.command()
@click.argument('name', help='The name to print')
@click.option('--count', default=1, help='number of greetings')
def hello(name: str, count: int):
    """This script prints hello and a name one or more times."""
    for x in range(count):
        if name:
            click.echo(f"Hello {name}!")
        else:
            click.echo("Hello!")

Metadata

Metadata

Assignees

No one assigned

    Labels

    f:helpfeature: help textf:parametersfeature: input parameter types

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions