🗑️ Deprecate support for is_flag and flag_value parameters
#987
Conversation
This file contains 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
svlandeg
commented
Sep 13, 2024
| callback=install_callback, | ||
| expose_value=False, | ||
| help="Install completion for the current shell.", | ||
| ), | ||
| show_completion: bool = Option( | ||
| None, | ||
| "--show-completion", | ||
| is_flag=True, |
There was a problem hiding this comment.
I'm not sure why we had these is_flag specifications here. I think we can just remove them, because we removed the parameter_info.is_flag is not False condition. Would be good if you could double check, @tiangolo 🙏
svlandeg
changed the title
is_flag and flag_value parametersis_flag and flag_value parameters
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.
Fixes #986
DeprecationWarningwhenOptionInforeceives a value foris_flagand/orflag_valueTyperOptiondoesn't useflag_valueanymore and itsis_flagis now defined only by looking at whether or notmain_type is boolThese parameters weren't actually functional (cf. #873) and they weren't documented, so I don't think this should be breaking. But it's always difficult to say - users could be relying on unspecified internals... 🫤