gh-123523: Rework typing documentation for generators and coroutines, and link to it from collections.abc docs
#123544
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
sterliakov
requested review from
JelleZijlstra,
AlexWaygood,
rhettinger and
1st1
as code owners
bedevere-app
bot
added
docs
AlexWaygood
reviewed
Aug 31, 2024
AlexWaygood
reviewed
Aug 31, 2024
Similarly to `collections.abc` changes, this is not acceptable for now.
AlexWaygood
reviewed
Sep 1, 2024
AlexWaygood
changed the title
typing to collections.abccollections.abc docs
AlexWaygood
reviewed
Sep 1, 2024
AlexWaygood
reviewed
Sep 1, 2024
|
You use the phrase "Refer to [this other documentation]" quite a lot -- I'd probably just use "See [this other documentation]" instead, as it's slightly shorter. But not strong opinion; I'm also okay with "Refer to". |
AlexWaygood
reviewed
Sep 1, 2024
AlexWaygood
reviewed
Sep 1, 2024
AlexWaygood
approved these changes
Sep 1, 2024
AlexWaygood
added
needs backport to 3.12
AlexWaygood
reviewed
Sep 1, 2024
… with `typing.Set`
picnixz
reviewed
Sep 3, 2024
AlexWaygood
reviewed
Sep 3, 2024
|
Thanks @sterliakov for the PR, and @AlexWaygood for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this pull request
Sep 6, 2024
…tines, and link to it from `collections.abc` docs (pythonGH-123544) (cherry picked from commit 56e4a41) Co-authored-by: Stanislav Terliakov <[email protected]>
|
Sorry, @sterliakov and @AlexWaygood, I could not cleanly backport this to |
|
GH-123790 is a backport of this pull request to the 3.13 branch. |
AlexWaygood
pushed a commit
to AlexWaygood/cpython
that referenced
this pull request
Sep 6, 2024
…d coroutines, and link to it from `collections.abc` docs (python#123544)
|
GH-123792 is a backport of this pull request to the 3.12 branch. |
AlexWaygood
added a commit
that referenced
this pull request
Sep 6, 2024
…utines, and link to it from `collections.abc` docs (#123544) (#123792) Co-authored-by: Stanislav Terliakov <[email protected]>
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/