Use tabs for generics docs #18264
Open
Use tabs for generics docs #18264
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
|
Is this something we'd want to add? @JukkaL you mentioned in #17810 (comment) that you wanted to see how it looks first. What do you think? |
|
It looks good to me. I think the initial code examples in the generic section can remain as is, so that the reader sees both syntax variants without having to switch tabs, but later on we can use tabs. However, I don't love the tab title "Legacy". What about "Old syntax" instead? |
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.
Followup to
Reformat docs to use
sphinx_inline_docsfor generics documentation to differentiate between legacy and Python 3.12+ syntax. Temporarily use custom requirement to be able to disable the tab sync. It might be desirable to compare both versions side by side. With the tab sync (the default), each switch would move the text around since the tab lengths are different. With the sync disabled, at least the top doesn't jump around.https://github.com/cdce8p/sphinx-inline-tabs/releases/tag/2024.12.07.b1
cdce8p/sphinx-inline-tabs@main...2024.12.07.b1