Visitar URL original
[3.11] gh-103921: Improve typing documentation (GH-104642) by JelleZijlstra · Pull Request #105007 · python/cpython · GitHub
Skip to content

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

Merged
JelleZijlstra merged 3 commits into
python:3.11from
JelleZijlstra:backport-060277d-3.11
May 27, 2023
Merged

[3.11] gh-103921: Improve typing documentation (GH-104642)#105007
JelleZijlstra merged 3 commits into
python:3.11from
JelleZijlstra:backport-060277d-3.11

Conversation

@JelleZijlstra

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

Copy link
Copy Markdown
Member

(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
Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst
Comment thread Doc/library/typing.rst Outdated
@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
Comment thread Doc/library/typing.rst Outdated
@bedevere-bot

bedevere-bot commented May 27, 2023

Copy link
Copy Markdown

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
Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
AlexWaygood
AlexWaygood approved these changes May 27, 2023
View reviewed changes

@AlexWaygood AlexWaygood left a comment

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.

Thanks!

@JelleZijlstra
JelleZijlstra merged commit d34e58a into python:3.11 May 27, 2023
@JelleZijlstra
JelleZijlstra deleted the backport-060277d-3.11 branch May 27, 2023 23:37
@AlexWaygood AlexWaygood mentioned this pull request Jun 11, 2023
Merged
@JelleZijlstra
JelleZijlstra restored the backport-060277d-3.11 branch September 10, 2024 23:37
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.

3 participants

@JelleZijlstra @bedevere-bot @AlexWaygood