Skip to content

gh-107422: Remove outdated TypedDict example from typing docs #107436

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
AlexWaygood merged 1 commit into from
Jul 29, 2023
Merged

gh-107422: Remove outdated TypedDict example from typing docs #107436

AlexWaygood merged 1 commit into from
Jul 29, 2023

Conversation

@ghubrakesh
Copy link
Contributor

@ghubrakesh ghubrakesh commented Jul 29, 2023 •
edited by AlexWaygood
Loading

Changed the lines:

      class XZ(X, Z): pass  # raises TypeError

-       T = TypeVar('T')
-      class XT(X, Generic[T]): pass  # raises TypeError
-

   A ``TypedDict`` can be generic::

      class Group[T](TypedDict):
          key: T

this example was redundant as it was explained in deep in the next few lines. So it needed to get removed.

📚 Documentation preview 📚: https://cpython-previews--107436.org.readthedocs.build/

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 29, 2023
@ghost
Copy link

ghost commented Jul 29, 2023 •
edited by ghost
Loading

All commit authors signed the Contributor License Agreement.
CLA signed

@AlexWaygood AlexWaygood changed the title changed typing.rst as mentioned in #107422 gh-107422: Remove outdated TypedDict example from typing docs Jul 29, 2023
@bedevere-bot bedevere-bot mentioned this pull request Jul 29, 2023
Closed
AlexWaygood
AlexWaygood approved these changes Jul 29, 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, looks good to me!

@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jul 29, 2023
@AlexWaygood AlexWaygood enabled auto-merge (squash) July 29, 2023 17:01
@AlexWaygood AlexWaygood merged commit 89fd4f4 into python:main Jul 29, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Jul 29, 2023

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

@miss-islington
Copy link
Contributor

miss-islington commented Jul 29, 2023

Sorry, @ghubrakesh and @AlexWaygood, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 89fd4f4a3fc5fb8076ec064c22a30108480e946b 3.11

@bedevere-bot
Copy link

bedevere-bot commented Jul 29, 2023

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 29, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 29, 2023
@ghubrakesh @miss-islington
pythongh-107422: Remove outdated TypedDict example from typing docs (…
2ee0a77 
…pythonGH-107436)

(cherry picked from commit 89fd4f4)

Co-authored-by: Rakesh Sabale <102187286+ghubrakesh@users.noreply.github.com>
@bedevere-bot
Copy link

bedevere-bot commented Jul 29, 2023

GH-107438 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 29, 2023
AlexWaygood pushed a commit that referenced this pull request Jul 29, 2023
@miss-islington @ghubrakesh
[3.12] gh-107422: Remove outdated TypedDict example from typing docs (
2c0a99d 
GH-107436) (#107437)

gh-107422: Remove outdated `TypedDict` example from typing docs (GH-107436)
(cherry picked from commit 89fd4f4)

Co-authored-by: Rakesh Sabale <102187286+ghubrakesh@users.noreply.github.com>
AlexWaygood added a commit that referenced this pull request Jul 29, 2023
@AlexWaygood @ghubrakesh
[3.11] gh-107422: Remove outdated TypedDict example from typing docs (
357708e 
#107436) (#107438)

gh-107422: Remove outdated `TypedDict` example from typing docs (#107436)

Co-authored-by: Rakesh Sabale <102187286+ghubrakesh@users.noreply.github.com>
@ghubrakesh
Copy link
Contributor Author

ghubrakesh commented Jul 29, 2023

Thank you, @AlexWaygood, for the guidance. This was my first contribution to open-source (Though it was a tiny one, It's special to me). Thank you so much for detailed description of the problem.

@AlexWaygood
Copy link
Member

AlexWaygood commented Jul 29, 2023

The first PR is always special! Thanks for the contribution @ghubrakesh, it was a good one :)

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

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

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

Assignees

@AlexWaygood AlexWaygood

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ghubrakesh @miss-islington @bedevere-bot @AlexWaygood