Skip to content

gh-124269: Simplify typing.Annotated docs - #130770

Merged
picnixz merged 7 commits into
python:mainfrom
StanFromIreland:gh-124269
Mar 14, 2025
Merged

picnixz merged 7 commits into
python:mainfrom
StanFromIreland:gh-124269

Conversation

@StanFromIreland

@StanFromIreland StanFromIreland commented Mar 2, 2025 •

Copy link
Copy Markdown
Member

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

Request: @JelleZijlstra @sobolevn @picnixz

Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
@picnixz
picnixz self-requested a review March 3, 2025 23:03
@picnixz

picnixz commented Mar 3, 2025

Copy link
Copy Markdown
Member

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

Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
@StanFromIreland

Copy link
Copy Markdown
Member Author

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

@picnixz friendly ping :-)

@picnixz

picnixz commented Mar 7, 2025

Copy link
Copy Markdown
Member

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

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
@StanFromIreland
StanFromIreland requested a review from picnixz March 7, 2025 18:31
Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst
@StanFromIreland
StanFromIreland requested a review from picnixz March 12, 2025 18:58

@picnixz picnixz 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.

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.

Comment thread Doc/library/typing.rst Outdated
Comment thread Doc/library/typing.rst Outdated
@StanFromIreland
StanFromIreland requested a review from picnixz March 13, 2025 15:41
Comment thread Doc/library/typing.rst Outdated
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
@miss-islington-app

Copy link
Copy Markdown

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
---------
(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

bedevere-app Bot commented Mar 14, 2025

Copy link
Copy Markdown

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 only security fixes label Mar 14, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Mar 14, 2025
---------
(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

bedevere-app Bot commented Mar 14, 2025

Copy link
Copy Markdown

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
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
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
…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
---------

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

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants