Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[3.11] gh-103921: Improve typing documentation (GH-104642) #105007

Merged
merged 3 commits into from May 27, 2023
Merged

[3.11] gh-103921: Improve typing documentation (GH-104642) #105007

merged 3 commits into from May 27, 2023

Conversation

JelleZijlstra
Copy link
Member

@JelleZijlstra JelleZijlstra commented May 27, 2023 •
edited by github-actions bot

(cherry picked from commit 060277d)

This backports some of the changes from the PEP 695 documentation PR (#104642) to 3.11, because I ended up making some improvements that are also applicable to older versions of typing:

  • Consistent indentation of examples in typing.rst
  • Document the call signature of TypeVar, ParamSpec, TypeVarTuple
  • Omit mention of the variance-related parameters of ParamSpec, which are not meaningful in the type system
  • Some wording improvements

馃摎 Documentation preview 馃摎: https://cpython-previews--105007.org.readthedocs.build/

@JelleZijlstra
[3.11] pythongh-103921: Document PEP 695 (pythonGH-104642)
0428d38 
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 060277d)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
This was referenced May 27, 2023
Closed
Merged
AlexWaygood
AlexWaygood reviewed May 27, 2023
View reviewed changes
Doc/library/typing.rst Outdated Show resolved Hide resolved
Doc/library/typing.rst Outdated Show resolved Hide resolved
Doc/library/typing.rst Outdated Show resolved Hide resolved
Doc/library/typing.rst Show resolved Hide resolved
Doc/library/typing.rst Outdated Show resolved Hide resolved
@JelleZijlstra @AlexWaygood
Apply suggestions from code review
c7e9ef8 
Thanks Alex!

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood
AlexWaygood requested changes May 27, 2023
View reviewed changes
Doc/library/typing.rst Outdated Show resolved Hide resolved
@bedevere-bot
Copy link

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

AlexWaygood
AlexWaygood reviewed May 27, 2023
View reviewed changes
Doc/library/typing.rst Outdated Show resolved Hide resolved
Doc/library/typing.rst Outdated Show resolved Hide resolved
AlexWaygood
AlexWaygood approved these changes May 27, 2023
View reviewed changes
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks!

@JelleZijlstra JelleZijlstra merged commit d34e58a into python:3.11 May 27, 2023
19 of 20 checks passed
@JelleZijlstra JelleZijlstra deleted the backport-060277d-3.11 branch May 27, 2023 23:37
@AlexWaygood AlexWaygood mentioned this pull request Jun 11, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlexWaygood AlexWaygood AlexWaygood approved these changes

@gvanrossum gvanrossum Awaiting requested review from gvanrossum gvanrossum is a code owner

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

Assignees
No one assigned
Labels
skip news
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@JelleZijlstra @bedevere-bot @AlexWaygood