GH-142928: Add deprecation warning for removal of color on HelpFormatter#142946
Uh oh!
There was an error while loading. Please reload this page.
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
Contributor
hroncok commented Dec 18, 2025
Thanks. Should this still attempt to call |
hugovk reviewed Dec 18, 2025
| * :mod:`argparse`: | ||
| * The *color* parameter of :class:`~argparse.HelpFormatter` is deprecated. |
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. |
| @@ -0,0 +1 @@ | |||
| Deprecate :class:`~argparse.HelpFormatter`'s *color* parameter. Users should use the *color* parameter on :class:`~argparse.ArgumentParser` instead. | |||
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. |
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment
3 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.
Never documented and buggy but alas, still used, so we need a deprecation warning. More context here: #142274 (comment)