Support typer arguments #134
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Stephen Finucane <stephen@that.guru>
stephenfin
force-pushed
the
typer-command
branch
from
6e01ca9
to
6448c69
Compare
|
Thanks 🙏 |
hoodmane
added a commit
to hoodmane/sphinx-click
that referenced
this pull request
May 9, 2024
This is a fix for a regression introduced in click-contrib#134. It's possible that the argument has a `help` attribute, but the value of it is `None`. We then hit a type error where we pass `None` to `re.sub`.
4 tasks
hoodmane
added a commit
to hoodmane/sphinx-click
that referenced
this pull request
May 9, 2024
This is a fix for a regression introduced in click-contrib#134. It's possible that the argument has a `help` attribute, but the value of it is `None`. We then hit a type error where we pass `None` to `re.sub`.
stephenfin
pushed a commit
that referenced
this pull request
May 14, 2024
This is a fix for a regression introduced in #134. It's possible that the argument has a `help` attribute, but the value of it is `None`. We then hit a type error where we pass `None` to `re.sub`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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