This is a proposal for consistency of the help attribute in options and arguments. Options can have help text, but arguments (currently) not. While click does not provide the help attribute for arguments, it allows subclasses to add it (and provide the custom subclass to @click.argument(…, cls=…)).
With a tiny change this greatly improves support for the popular typer package.
If the help attribute is detected on an argument, it is interpreted just like for options. Otherwise the behavior is as before.
Tasks
[x] Added unit tests
[ ] Added documentation for new features (where applicable)
stephenfin
commented
3 months ago
Summary
This is a proposal for consistency of the
helpattribute in options and arguments. Options can have help text, but arguments (currently) not. While click does not provide thehelpattribute for arguments, it allows subclasses to add it (and provide the custom subclass to@click.argument(…, cls=…)).With a tiny change this greatly improves support for the popular typer package.
If the
helpattribute is detected on an argument, it is interpreted just like for options. Otherwise the behavior is as before.Tasks
reno)tox)Further details
Solves #132