Skip to content

gh-103099: Link mypy docs from typing.rst #103100

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.

Sign up for GitHub

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

Merged
hauntsaninja merged 6 commits into from
Mar 30, 2023
Merged

gh-103099: Link mypy docs from typing.rst #103100

Changes from 2 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e3a08e7
gh-103099: Link mypy docs from typing.rst
hauntsaninja Mar 28, 2023
f009a26
extra and
hauntsaninja Mar 28, 2023
6b5ac06
wording
hauntsaninja Mar 29, 2023
77ffdef
Update Doc/library/typing.rst
hauntsaninja Mar 29, 2023
6ca2d94
single seealso
hauntsaninja Mar 29, 2023
11da570
link to cheat sheet directly
hauntsaninja Mar 29, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion Doc/library/typing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,19 @@ provides backports of these new features to older versions of Python.
For a summary of deprecated features and a deprecation timeline, please see
`Deprecation Timeline of Major Features`_.

.. seealso::

The documentation at https://mypy.readthedocs.io/ provides accessible
descriptions of various type system features. Particularly refer to the "Type
Comment thread
hauntsaninja marked this conversation as resolved.
Resolved
System Reference" section of the docs -- since the Python typing system is
standardised via PEPs, this information should apply to most Python type
checkers.

.. seealso::

@AlexWaygood AlexWaygood Mar 29, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: I'd prefer it if we had one .. seealso box with multiple links in it, similar to the one we have here, rather than two consecutive .. seealso boxes

@hauntsaninja hauntsaninja Mar 29, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the other seealso https://deploy-preview-103100--python-cpython-preview.netlify.app/library/typing.html
I think it's mostly fine, but it's not as nice as the seealso you link because it doesn't have bold headings. I don't really have good heading names in mind, so I'm happy to merge as is.


The documentation at https://typing.readthedocs.io/ serves as useful reference
for type system features, useful typing related tools and typing best practices.


.. _relevant-peps:

Relevant PEPs
Expand Down