-
-
Notifications
You must be signed in to change notification settings - Fork 33.9k
ArgumentDefaultsHelpFormatter: fix docstring #101591
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
serhiy-storchaka
merged 5 commits into
python:main
from
ferdnyc:argparse-formatter-docstring
Feb 21, 2024
Merged
ArgumentDefaultsHelpFormatter: fix docstring #101591
serhiy-storchaka
merged 5 commits into
python:main
from
ferdnyc:argparse-formatter-docstring
Feb 21, 2024
Conversation
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
Signed-off-by: FeRD (Frank Dana) <ferdnyc@gmail.com>
Contributor
Author
|
@michiboo Do you have a moment to look at this? It's purely a docstring adjustment, related to your previous changes to |
Contributor
Author
serhiy-storchaka
approved these changes
Feb 21, 2024
Member
|
Thank you for reporting and fixing this issue. |
woodruffw
pushed a commit
to woodruffw-forks/cpython
that referenced
this pull request
Mar 4, 2024
pythonGH-101591) Signed-off-by: FeRD (Frank Dana) <ferdnyc@gmail.com>
diegorusso
pushed a commit
to diegorusso/cpython
that referenced
this pull request
Apr 17, 2024
pythonGH-101591) Signed-off-by: FeRD (Frank Dana) <ferdnyc@gmail.com>
LukasWoodtli
pushed a commit
to LukasWoodtli/cpython
that referenced
this pull request
Jan 22, 2025
pythonGH-101591) Signed-off-by: FeRD (Frank Dana) <ferdnyc@gmail.com>
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.
In #27808
@michiboo@abadger enhanced the display of default values inargparsehelp messages. Unfortunately, the docstring forargparse.ArgumentDefaultsHelpFormattergot somewhat garbled along the way.Originally, commit 336bd2f added a new function,
_add_defaults_to_help_string, documented as:But subsequent commit dc4babf incorporated that functionality into
argparse.ArgumentDefaultsHelpFormatter._get_help_stringinstead, and its docstring was set to:This PR
clears up and simplifiesremoves that docstring, as it didn't really add information not discernible just by reading the code.