Repository navigation
gh-123523: Rework typing documentation for generators and coroutines, and link to it from collections.abc docs - #123544
Merged
AlexWaygood merged 18 commits intoSep 6, 2024
Conversation
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 #123523.
Aliases from
typingtocollections.abcandcontextlibmodules are deprecated for a long time, and typing-related documentation should be easily reachable from the modern pages.This PR moves all non-trivial descriptions between these pages and lists generic arguments for these aliases.
I'm using PEP695 syntax for these classes - it doesn't seem right to document them as inheriting from
Generic, since they do not in fact (they define__class_getitem__directly).typingdocs tocollections.abc#123523📚 Documentation preview 📚: https://cpython-previews--123544.org.readthedocs.build/