From e3a08e7b39a11f071f2e2d099b69455e6fb5986d Mon Sep 17 00:00:00 2001 From: hauntsaninja Date: Tue, 28 Mar 2023 16:24:17 -0700 Subject: [PATCH 1/6] gh-103099: Link mypy docs from typing.rst --- Doc/library/typing.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 08ffa0310f0f23..253407367cad32 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -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 and + descriptions of various type system features. Particularly refer to the "Type + 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:: 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 From f009a269f8e3251bd19cd5471fc6700d326c591a Mon Sep 17 00:00:00 2001 From: hauntsaninja Date: Tue, 28 Mar 2023 16:47:06 -0700 Subject: [PATCH 2/6] extra and --- Doc/library/typing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 253407367cad32..c095c4bb268124 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -41,7 +41,7 @@ For a summary of deprecated features and a deprecation timeline, please see .. seealso:: - The documentation at https://mypy.readthedocs.io/ provides accessible and + The documentation at https://mypy.readthedocs.io/ provides accessible descriptions of various type system features. Particularly refer to the "Type System Reference" section of the docs -- since the Python typing system is standardised via PEPs, this information should apply to most Python type From 6b5ac06125a4932dbfee32bfedba695167dd9cfa Mon Sep 17 00:00:00 2001 From: hauntsaninja Date: Tue, 28 Mar 2023 17:52:13 -0700 Subject: [PATCH 3/6] wording --- Doc/library/typing.rst | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index c095c4bb268124..92370cbd1fef86 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -41,11 +41,10 @@ For a summary of deprecated features and a deprecation timeline, please see .. seealso:: - The documentation at https://mypy.readthedocs.io/ provides accessible - descriptions of various type system features. Particularly refer to the "Type - System Reference" section of the docs -- since the Python typing system is - standardised via PEPs, this information should apply to most Python type - checkers. + The "Type System Reference" section of https://mypy.readthedocs.io/ -- since + the Python typing system is standardised via PEPs, this reference should + broadly apply to most Python type checkers, although some parts may still be + mypy specific. .. seealso:: From 77ffdef54dc375bca7869e8abfa725c163bb97da Mon Sep 17 00:00:00 2001 From: Shantanu <12621235+hauntsaninja@users.noreply.github.com> Date: Tue, 28 Mar 2023 18:00:31 -0700 Subject: [PATCH 4/6] Update Doc/library/typing.rst Co-authored-by: Alex Waygood --- Doc/library/typing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 92370cbd1fef86..888ea367404aff 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -44,7 +44,7 @@ For a summary of deprecated features and a deprecation timeline, please see The "Type System Reference" section of https://mypy.readthedocs.io/ -- since the Python typing system is standardised via PEPs, this reference should broadly apply to most Python type checkers, although some parts may still be - mypy specific. + specific to mypy. .. seealso:: From 6ca2d949d0a662ab8ddf0615f24c60a728402ea7 Mon Sep 17 00:00:00 2001 From: hauntsaninja Date: Tue, 28 Mar 2023 18:19:20 -0700 Subject: [PATCH 5/6] single seealso --- Doc/library/typing.rst | 2 -- 1 file changed, 2 deletions(-) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index 888ea367404aff..eb8fd430dfe257 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -46,8 +46,6 @@ For a summary of deprecated features and a deprecation timeline, please see broadly apply to most Python type checkers, although some parts may still be specific to mypy. -.. seealso:: - The documentation at https://typing.readthedocs.io/ serves as useful reference for type system features, useful typing related tools and typing best practices. From 11da5700523125250f765c89f43b92d85efa38b6 Mon Sep 17 00:00:00 2001 From: hauntsaninja Date: Tue, 28 Mar 2023 22:21:37 -0700 Subject: [PATCH 6/6] link to cheat sheet directly --- Doc/library/typing.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Doc/library/typing.rst b/Doc/library/typing.rst index eb8fd430dfe257..384458d3aa6618 100644 --- a/Doc/library/typing.rst +++ b/Doc/library/typing.rst @@ -41,6 +41,9 @@ For a summary of deprecated features and a deprecation timeline, please see .. seealso:: + For a quick overview of type hints, refer to + `this cheat sheet `_. + The "Type System Reference" section of https://mypy.readthedocs.io/ -- since the Python typing system is standardised via PEPs, this reference should broadly apply to most Python type checkers, although some parts may still be