Repository navigation
Add help to argument parameter #2983
Description
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.
@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!")
Activity
KarinaNi commentedon Jun 26, 2025
Rowlando13 commentedon Jun 26, 2025
@KarinaNi Let's try the other issue first. It is a bit more approachable.
yurishevtsov commentedon May 19, 2026
@Rowlando13 PR open and ready for review. Let me know if you have any feedback.
[-]Add help kwarg to argument parameter[/-][+]Add `help` to argument parameter[/+]kdeldycke commentedon May 23, 2026
Relates to:
Add help parameter to arguments