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

Jump to bottom
Merged
merged 6 commits into from
Mar 30, 2023
Merged

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

merged 6 commits into from
Mar 30, 2023

Conversation

hauntsaninja
Copy link
Contributor

@hauntsaninja hauntsaninja commented Mar 28, 2023 •
edited by bedevere-bot
Loading

@bedevere-bot bedevere-bot added docs Documentation in the Doc dir skip news labels Mar 28, 2023
@bedevere-bot bedevere-bot mentioned this pull request Mar 28, 2023
Closed
@hauntsaninja hauntsaninja mentioned this pull request Mar 28, 2023
Merged
AlexWaygood
AlexWaygood reviewed Mar 29, 2023
View reviewed changes
AlexWaygood
AlexWaygood reviewed Mar 29, 2023
View reviewed changes
Doc/library/typing.rst Outdated
the Python typing system is standardised via PEPs, this reference should
broadly apply to most Python type checkers, although some parts may still be
specific to mypy.

.. seealso::
Copy link
Member

@AlexWaygood AlexWaygood Mar 29, 2023 •
edited
Loading

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

Copy link
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.

@hauntsaninja
Copy link
Contributor Author

hauntsaninja commented Mar 29, 2023 •
edited
Loading

I made one more change: linking to mypy's type hinting cheat sheet.

sobolevn
sobolevn approved these changes Mar 29, 2023
View reviewed changes
Copy link
Member

@sobolevn sobolevn left a comment

Choose a reason for hiding this comment

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

Thanks! This is very much needed

@hauntsaninja hauntsaninja merged commit fda95aa into python:main Mar 30, 2023
@miss-islington
Copy link
Contributor

Thanks @hauntsaninja for the PR 🌮🎉.. I'm working now to backport this PR to: 3.10, 3.11.
🐍🍒⛏🤖

@hauntsaninja hauntsaninja deleted the gh-103099 branch March 30, 2023 08:32
@bedevere-bot
Copy link

GH-103126 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Mar 30, 2023
@bedevere-bot
Copy link

GH-103127 is a backport of this pull request to the 3.10 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.10 only security fixes label Mar 30, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 30, 2023
@hauntsaninja @miss-islington
pythongh-103099: Link mypy docs from typing.rst (pythonGH-103100)
329f80c 
(cherry picked from commit fda95aa)

Co-authored-by: Shantanu <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 30, 2023
@hauntsaninja @miss-islington
pythongh-103099: Link mypy docs from typing.rst (pythonGH-103100)
c4bcff8 
(cherry picked from commit fda95aa)

Co-authored-by: Shantanu <[email protected]>
miss-islington added a commit that referenced this pull request Mar 30, 2023
@miss-islington @hauntsaninja
gh-103099: Link mypy docs from typing.rst (GH-103100)
1b40618 
(cherry picked from commit fda95aa)

Co-authored-by: Shantanu <[email protected]>
miss-islington added a commit that referenced this pull request Mar 30, 2023
@miss-islington @hauntsaninja
gh-103099: Link mypy docs from typing.rst (GH-103100)
ba755a2 
(cherry picked from commit fda95aa)

Co-authored-by: Shantanu <[email protected]>
warsaw pushed a commit to warsaw/cpython that referenced this pull request Apr 11, 2023
@hauntsaninja @warsaw
pythongh-103099: Link mypy docs from typing.rst (python#103100)
b188cc8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood left review comments

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

@sobolevn sobolevn sobolevn approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum

@Fidget-Spinner Fidget-Spinner Awaiting requested review from Fidget-Spinner

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip news topic-typing
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@hauntsaninja @miss-islington @bedevere-bot @JelleZijlstra @sobolevn @AlexWaygood