-
-
Notifications
You must be signed in to change notification settings - Fork 33.7k
bpo-45680: typing docs: improve links to docs on GenericAlias/__class_getitem__
#29387
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
bpo-45680: typing docs: improve links to docs on GenericAlias/__class_getitem__
#29387
Conversation
…/``__class_getitem__``
typing docs: improve links to docs on GenericAlias…typing docs: improve links to docs on GenericAlias/__class_getitem__
Fidget-Spinner
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mostly looks good to me, just one question and comment.
| *Introducing* the ability to use builtin collections and ABCs as | ||
| :term:`generic types<generic type>` | ||
| *Introducing* :class:`types.GenericAlias` and the ability to use standard | ||
| library classes as :ref:`generic types<types-genericalias>` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait, why'd the link change from the one in the glossary to about types-genericalias?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My reasoning was:
- I think the
types-genericaliaslink is more informative about the change that was introduced in the PEP. - I think it's an important piece of documentation that deserves a prominent mention near the top of the
typingdocs. - It's consistent with the link to
types-unionin the bullet point about PEP 604.
But I'm very happy to revert this change if you think the link to the glossary is more appropriate here 🙂
Misc/NEWS.d/next/Documentation/2021-11-03-14-51-03.bpo-45680.9_NTFU.rst
Outdated
Show resolved
Hide resolved
|
Thanks @AlexWaygood for the PR, and @Fidget-Spinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9. |
|
Thanks @AlexWaygood for the PR, and @Fidget-Spinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.10. |
|
Sorry @AlexWaygood and @Fidget-Spinner, I had trouble checking out the |
…/``__class_getitem__`` (pythonGH-29387) (cherry picked from commit e03e503) Co-authored-by: Alex Waygood <[email protected]>
|
GH-29399 is a backport of this pull request to the 3.10 branch. |
|
Thanks @AlexWaygood for the PR, and @Fidget-Spinner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.9. |
…/``__class_getitem__`` (pythonGH-29387) (cherry picked from commit e03e503) Co-authored-by: Alex Waygood <[email protected]>
|
GH-29400 is a backport of this pull request to the 3.9 branch. |
…/``__class_getitem__`` (GH-29387) (cherry picked from commit e03e503) Co-authored-by: Alex Waygood <[email protected]>
…/``__class_getitem__`` (GH-29387) (cherry picked from commit e03e503) Co-authored-by: Alex Waygood <[email protected]>
This PR has been split off from #29335
https://bugs.python.org/issue45680