Skip to content

gh-123523: Rework typing documentation for generators and coroutines, and link to it from collections.abc docs - #123544

Merged
AlexWaygood merged 18 commits into
python:mainfrom
sterliakov:docs/gh-123523-pep585-typing-docs
Sep 6, 2024
Merged

AlexWaygood merged 18 commits into
python:mainfrom
sterliakov:docs/gh-123523-pep585-typing-docs

Conversation

@sterliakov

@sterliakov sterliakov commented Aug 31, 2024 •

Copy link
Copy Markdown
Contributor

Fixes #123523.

Aliases from typing to collections.abc and contextlib modules 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).


📚 Documentation preview 📚: https://cpython-previews--123544.org.readthedocs.build/

Loading
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Move typing-related usage of PEP585 generics from typing docs to collections.abc

4 participants