GH-142928: Add deprecation warning for removal of color on HelpFormatter - #142946
Closed
savannahostrowski wants to merge 4 commits into
Closed
GH-142928: Add deprecation warning for removal of color on HelpFormatter#142946savannahostrowski wants to merge 4 commits into
savannahostrowski wants to merge 4 commits into
Conversation
Copy link
Copy Markdown
Member
Sorry, something went wrong.
Copy link
Copy Markdown
Contributor
|
Thanks. Should this still attempt to call self._set_color(color) in this case? Or else if it cannot, say "deprecated and does nothing" in the warning/docs? |
Sorry, something went wrong.
hugovk
reviewed
Dec 18, 2025
Comment thread
Doc/whatsnew/3.15.rst
|
|
||
| * :mod:`argparse`: | ||
|
|
||
| * The *color* parameter of :class:`~argparse.HelpFormatter` is deprecated. |
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
It's undocumented, fix the Sphinx warning:
Suggested change
| * The *color* parameter of :class:`~argparse.HelpFormatter` is deprecated. | |
| * The *color* parameter of :class:`!HelpFormatter` is deprecated. |
Sorry, something went wrong.
| @@ -0,0 +1 @@ | |||
| Deprecate :class:`~argparse.HelpFormatter`'s *color* parameter. Users should use the *color* parameter on :class:`~argparse.ArgumentParser` instead. | |||
Copy link
Copy Markdown
Member
There was a problem hiding this comment.
Suggested change
| Deprecate :class:`~argparse.HelpFormatter`'s *color* parameter. Users should use the *color* parameter on :class:`~argparse.ArgumentParser` instead. | |
| Deprecate :class:`!HelpFormatter`'s *color* parameter. Use the *color* parameter on :class:`~argparse.ArgumentParser` instead. |
Sorry, something went wrong.
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
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.
Never documented and buggy but alas, still used, so we need a deprecation warning. More context here: #142274 (comment)