WIP: Add @custom_version_option, freeze @version_option#3581
Draft
kdeldycke wants to merge 1 commit into
Draft
Conversation
6360211 to
9a54d78
Compare
9a54d78 to
dddd703
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
1 participant
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.
This is an attempt to address the design discussion we started in #3527 about
@version_optionextensibility.What's in this PR:
.. note::admonition to point to@version_optionfreeze.@custom_version_optionthat mirrors@help_optionand@version_optionand takes a callback for a custom message.I did not take the class-based approach here, as it reminded me of the
HelpOptionclass that I was too fast to add in #2563 (v8.1.8) then had to remove in #2832/#2840 (v8.2.0).If I like the explicitness of the freeze admonition, I don't like the rest of the code: the naming of
@custom_version_optionand the apparent duplication with@version_option. But I produced this PR anyway to explore the effect of our policy and to have a concrete example to discuss.