Skip to content

Conversation

@cdce8p
Copy link
Collaborator

@cdce8p cdce8p commented Dec 7, 2024

Followup to

Reformat docs to use sphinx_inline_docs for 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-forks/sphinx-inline-tabs@main...2024.12.07.b1

@cdce8p
Copy link
Collaborator Author

cdce8p commented Dec 7, 2024

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?

@JukkaL
Copy link
Collaborator

JukkaL commented Dec 20, 2024

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants