Many typing PEPs: add more links to canonical docs #3821
Merged
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
AlexWaygood
requested review from
JelleZijlstra,
gvanrossum,
ilevkivskyi,
ambv,
lisroach and
AA-Turner
as code owners
hugovk
reviewed
Jun 5, 2024
pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py
Outdated
Show resolved
Hide resolved
ilevkivskyi
approved these changes
Jun 5, 2024
hugovk
approved these changes
Jun 6, 2024
hugovk
approved these changes
Jun 6, 2024
hauntsaninja
reviewed
Jun 7, 2024
pep_sphinx_extensions/pep_processor/parsing/pep_banner_directive.py
Outdated
Show resolved
Hide resolved
hauntsaninja
approved these changes
Jun 10, 2024
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.
The new banners we have the top of many of the typing PEPs, taking people to the typing spec, are great. The typing spec generally only details how these special forms, decorators or classes should be interpreted by type checkers, however. Lots of these PEPs also introduced objects that were added to the runtime typing module, and if you're interested in how these objects behave at runtime, the docs at CPython are still usually the best place to go for details.
This PR adds additional links to the CPython docs for many of these typing PEPs. It also updates the wording of the banner, so that it's clear that the typing spec is not necessarily the sole source of documentation on these objects. Lastly, there are a couple of typing PEPs that don't yet have a "canonical banner" at the top; I added some links to a few of those.
📚 Documentation preview 📚: https://pep-previews--3821.org.readthedocs.build/