Skip to content

Improve typing.TypeGuard docstring #117521

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
Closed
JelleZijlstra opened this issue Apr 3, 2024 · 2 comments
Closed

Improve typing.TypeGuard docstring #117521

JelleZijlstra opened this issue Apr 3, 2024 · 2 comments
Assignees
@JelleZijlstra
Labels
docs Documentation in the Doc dir topic-typing

Comments

@JelleZijlstra
Copy link
Member

JelleZijlstra commented Apr 3, 2024 •
edited by bedevere-app bot
Loading

The current docstring for typing.TypeGuard includes a single example, but that example does not use TypeGuard, and in fact demonstrates behavior that differs from that of TypeGuard in essential ways. It would be less confusing if the TypeGuard example actually exemplified TypeGuard.

Linked PRs
@JelleZijlstra JelleZijlstra added docs Documentation in the Doc dir topic-typing labels Apr 3, 2024
@JelleZijlstra JelleZijlstra self-assigned this Apr 3, 2024
JelleZijlstra added a commit to JelleZijlstra/cpython that referenced this issue Apr 3, 2024
@JelleZijlstra
pythongh-117521: Improve typing.TypeGuard docstring
1ac193c
@bedevere-app bedevere-app bot mentioned this issue Apr 3, 2024
Merged
JelleZijlstra added a commit that referenced this issue Apr 4, 2024
@JelleZijlstra
gh-117521: Improve typing.TypeGuard docstring (#117522)
b32789c
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Apr 4, 2024
@JelleZijlstra @miss-islington
pythongh-117521: Improve typing.TypeGuard docstring (pythonGH-117522)
5055b3d 
(cherry picked from commit b32789c)

Co-authored-by: Jelle Zijlstra <[email protected]>
@bedevere-app bedevere-app bot mentioned this issue Apr 4, 2024
Merged
JelleZijlstra added a commit that referenced this issue Apr 4, 2024
@miss-islington @JelleZijlstra
[3.12] gh-117521: Improve typing.TypeGuard docstring (GH-117522) (#11…
b5e12aa 
…7538)

(cherry picked from commit b32789c)

Co-authored-by: Jelle Zijlstra <[email protected]>
@nineteendo
Copy link
Contributor

Can this be closed, or must this be backported to 3.11?

@AlexWaygood
Copy link
Member

It can't be backported any further than it already has been, as Python 3.11 is no longer accepting any changes unless they relate to security issues. So this can be closed now, thanks!

diegorusso pushed a commit to diegorusso/cpython that referenced this issue Apr 17, 2024
@JelleZijlstra @diegorusso
pythongh-117521: Improve typing.TypeGuard docstring (python#117522)
9f8bd31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@JelleZijlstra JelleZijlstra

Labels
docs Documentation in the Doc dir topic-typing
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@JelleZijlstra @nineteendo @AlexWaygood