Add help parameter to arguments#3473
Merged
kdeldycke merged 1 commit intoMay 28, 2026
Merged
Conversation
yurishevtsov
force-pushed
the
add-help-kwarg-to-arg-params
branch
4 times, most recently
from
73e3c13 to
b145f91
Compare
yurishevtsov
force-pushed
the
add-help-kwarg-to-arg-params
branch
from
b145f91 to
71240f8
Compare
Collaborator
|
That feature exists in Cloup since v0.1.40: https://github.com/janluke/cloup/releases/tag/v0.14.0 . So additional review from @janluke would be great! :) |
kdeldycke
requested changes
May 23, 2026
Collaborator
kdeldycke
left a comment
kdeldycke
left a comment
There was a problem hiding this comment.
Good PR that mirrors the way help is managed on Option.
This was
linked to
issues
May 23, 2026
Collaborator
|
@yurishevtsov After you fix up the few things listed, then should be good to go. |
yurishevtsov
force-pushed
the
add-help-kwarg-to-arg-params
branch
from
b02456f to
21942ed
Compare
Contributor
Author
|
Pushed 21942ed addressing all the review feedback:
Branch is rebased onto current |
kdeldycke
approved these changes
May 28, 2026
Collaborator
kdeldycke
left a comment
kdeldycke
left a comment
There was a problem hiding this comment.
This is good to be merged to main.
Closes pallets#2983 Co-authored-by: Rowlando13 <67291205+Rowlando13@users.noreply.github.com> Co-authored-by: Kevin Deldycke <kdeldycke@users.noreply.github.com>
kdeldycke
force-pushed
the
add-help-kwarg-to-arg-params
branch
from
21942ed to
04cd2e4
Compare
kdeldycke
force-pushed
the
add-help-kwarg-to-arg-params
branch
from
04cd2e4 to
684b3f5
Compare
Collaborator
|
Just updated the tests so this is immune to the #3509 issue, then rebase that PR on top of Let's merge this PR! :) |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Adds a
helpparameter toclick.argument()and an Arguments section on--helpwhen argument help is set. Commands without argument help are unchanged.Implementation follows options:
Argument.get_help_record()returns the metavar and help text for the help formatter (the baseParameterclass returnsNone, so arguments never appeared in help tables before).Argument.to_info_dict()now includeshelp, matchingOption, so parameter metadata stays consistent for doc tools; this is not required for CLI help output.Deprecated arguments without explicit
helpshow a deprecation-only row in Arguments, matching deprecated options.fixes #2983