Add help parameter to arguments#3473
Open
yurishevtsov wants to merge 1 commit into
Open
Conversation
yurishevtsov
force-pushed
the
add-help-kwarg-to-arg-params
branch
4 times, most recently
from
73e3c13 to
b145f91
Compare
Refactor: pull out args formatter into a dedicated method
yurishevtsov
force-pushed
the
add-help-kwarg-to-arg-params
branch
from
b145f91 to
71240f8
Compare
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
2 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