Add a doc for supporting 8.1.x|8.2.0 #2929
Merged
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
This uses `get_metavar` as an example, demonstrates how to feature-detect based on `kwargs` containing `"ctx"`, and shows simplified usage. A note block indicates how this same strategy applies to other ``ParamType`` methods. Section naming is setup to support: - future documentation of other version transitions - documentation of other transitional methods for 8.1 vs 8.2
Member
|
I converted this to Markdown since we now have myst-parser available. Then did some further editing. Added a link to our version policy, and a general description of feature detection. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This uses
get_metavaras an example, demonstrates how to feature-detect based onkwargscontaining"ctx", and shows simplified usage.A note block indicates how this same strategy applies to other
ParamTypemethods.Section naming is setup to support:
There are lots of details here on which I have no particularly strong opinion (e.g., precise doc name or section names), and am happy to work through feedback.