8000 gh-124269: Simplify `typing.Annotated` docs by StanFromIreland · Pull Request #130770 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

gh-124269: Simplify typing.Annotated docs #130770

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 7 commits into from
Mar 14, 2025
Merged

gh-124269: Simplify typing.Annotated docs #130770

merged 7 commits into from
Mar 14, 2025

Conversation

StanFromIreland
Copy link
Contributor
@StanFromIreland StanFromIreland commented Mar 2, 2025 •
edited by bedevere-app bot
Loading

Grouped relevant bullet points into paragraphs. Maybe I took too many creative liberties...

Request: @JelleZijlstra @sobolevn @picnixz

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Mar 2, 2025
@bedevere-app bedevere-app bot mentioned this pull request Mar 2, 2025
Closed
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Mar 2, 2025
StanFromIreland
StanFromIreland commented Mar 2, 2025
View reviewed changes
JelleZijlstra
JelleZijlstra reviewed Mar 3, 2025
View reviewed changes
@picnixz picnixz self-requested a review March 3, 2025 23:03
@picnixz
Copy link
Member
picnixz commented Mar 3, 2025

I forgot about this one. If Jelle approves the PR today, go ahead and merge it, or I'll review it tomorrow.

JelleZijlstra
JelleZijlstra reviewed Mar 3, 2025
View reviewed changes
@StanFromIreland @JelleZijlstra
Apply suggestions
d9ce974 
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@JelleZijlstra JelleZijlstra added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Mar 3, 2025
@StanFromIreland
Copy link
Contributor Author

If Jelle approves the PR today, go ahead and merge it

@picnixz friendly ping :-)

@picnixz
Copy link
Member
picnixz commented Mar 7, 2025

I'm currently travelling so I don't have time to review sorry. Nikita/Alex could also review the PR but I trust Jelle's judgment on this one so if he wants to merge it, go ahead. I can review it when I'm at the airport in a few hours though

picnixz
picnixz reviewed Mar 7, 2025
View reviewed changes
@StanFromIreland StanFromIreland requested a review from picnixz March 7, 2025 18:31
picnixz
picnixz reviewed Mar 8, 2025
View reviewed changes
@StanFromIreland StanFromIreland requested a review from picnixz March 12, 2025 18:58
picnixz
picnixz reviewed Mar 13, 2025
View reviewed changes
Copy link
Member
@picnixz picnixz left a comment

Choose a reason for hiding this comment

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

I'm unusure whether the import are actually needed because the current code has from typing import Annotated, get_origin and then a different doctest block for get_origin(Password) so I don't know if they're correctly being tested. Apparently, yes though.

@StanFromIreland StanFromIreland requested a review from picnixz March 13, 2025 15:41
picnixz
picnixz approved these changes Mar 13, 2025
View reviewed changes
@StanFromIreland @picnixz
Update with Benedikts suggestions
54e3b19 
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@picnixz picnixz self-assigned this Mar 13, 2025
@picnixz picnixz merged commit e4ac196 into python:main Mar 14, 2025
24 checks passed
@miss-islington-app
Copy link

Thanks @StanFromIreland for the PR, and @picnixz for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Mar 14, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 14, 2025
@StanFromIreland @JelleZijlstra
@picnixz @miss-islington
pythongh-124269: Simplify typing.Annotated docs (pythonGH-130770)
af3739b 
---------
(cherry picked from commit e4ac196)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
@bedevere-app
Copy link
bedevere-app bot commented Mar 14, 2025

GH-131222 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Mar 14, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 14, 2025
@StanFromIreland @JelleZijlstra
@picnixz @miss-islington
pythongh-124269: Simplify typing.Annotated docs (pythonGH-130770)
812fccf 
---------
(cherry picked from commit e4ac196)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
6855
@bedevere-app
Copy link
bedevere-app bot commented Mar 14, 2025

GH-131223 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Mar 14, 2025
@StanFromIreland StanFromIreland deleted the gh-124269 branch March 14, 2025 09:50
picnixz added a commit that referenced this pull request Mar 14, 2025
@miss-islington @StanFromIreland
@JelleZijlstra @picnixz
[3.13] gh-124269: Simplify typing.Annotated docs (GH-130770) (#131222)
0f97abf 
gh-124269: Simplify `typing.Annotated` docs (GH-130770)

---------
(cherry picked from commit e4ac196)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
picnixz added a commit that referenced this pull request Mar 14, 2025
@miss-islington @StanFromIreland
@JelleZijlstra @picnixz
[3.12] gh-124269: Simplify typing.Annotated docs (GH-130770) (#131223)
39b4f8b 
gh-124269: Simplify `typing.Annotated` docs (GH-130770)

---------
(cherry picked from commit e4ac196)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
mikec9 pushed a commit to mikec9/cpython that referenced this pull request Mar 14, 2025
@miss-islington @StanFromIreland
@JelleZijlstra @picnixz
[3.12] pythongh-124269: Simplify typing.Annotated docs (pythonGH-13…
f3902d1 
…0770) (python#131223)

pythongh-124269: Simplify `typing.Annotated` docs (pythonGH-130770)

---------
(cherry picked from commit e4ac196)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
plashchynski pushed a commit to plashchynski/cpython that referenced this pull request Mar 17, 2025
@StanFromIreland @JelleZijlstra
@picnixz @plashchynski
pythongh-124269: Simplify typing.Annotated docs (python#130770)
ea0904f 
---------

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
seehwan pushed a commit to seehwan/cpython that referenced this pull request Apr 16, 2025
@StanFromIreland @JelleZijlstra
@picnixz @seehwan80
pythongh-124269: Simplify typing.Annotated docs (python#130770)
bde41f0 
---------

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@picnixz picnixz picnixz approved these change 6D09 s

@JelleZijlstra JelleZijlstra JelleZijlstra approved these changes

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

Assignees

@picnixz picnixz

Labels
docs Documentation in the Doc dir skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@StanFromIreland @picnixz @JelleZijlstra
0