Skip to content

Example in dataclass documentation is incorrectly typed #98576

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
hauntsaninja opened this issue Oct 23, 2022 · 1 comment
Closed

Example in dataclass documentation is incorrectly typed #98576

hauntsaninja opened this issue Oct 23, 2022 · 1 comment
Labels
docs Documentation in the Doc dir topic-typing

Comments

@hauntsaninja
Copy link
Contributor

hauntsaninja commented Oct 23, 2022 •
edited by AlexWaygood
Loading

The example of InitVar in dataclass documentation does not pass static type checking. This caused some confusion here: python/mypy#13934
@hauntsaninja hauntsaninja added the docs Documentation in the Doc dir label Oct 23, 2022
hauntsaninja added a commit to hauntsaninja/cpython that referenced this issue Oct 23, 2022
@hauntsaninja
pythongh-98576: Fix types in dataclass.InitVar example
467985f
@bedevere-bot bedevere-bot mentioned this issue Oct 23, 2022
Merged
ericvsmith pushed a commit that referenced this issue Oct 31, 2022
@hauntsaninja
gh-98576: Fix types in dataclass.InitVar example (gh-98577)
880bafc
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 31, 2022
@hauntsaninja @miss-islington
pythongh-98576: Fix types in dataclass.InitVar example (pythongh-98577)
a1f62c7 
(cherry picked from commit 880bafc)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
This was referenced Oct 31, 2022
Merged
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 31, 2022
@hauntsaninja @miss-islington
pythongh-98576: Fix types in dataclass.InitVar example (pythongh-98577)
d270ebc 
(cherry picked from commit 880bafc)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
miss-islington added a commit that referenced this issue Oct 31, 2022
@miss-islington @hauntsaninja
gh-98576: Fix types in dataclass.InitVar example (gh-98577)
1907e5a 
(cherry picked from commit 880bafc)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
miss-islington added a commit that referenced this issue Oct 31, 2022
@miss-islington @hauntsaninja
gh-98576: Fix types in dataclass.InitVar example (gh-98577)
f6f07b2 
(cherry picked from commit 880bafc)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
@AlexWaygood
Copy link
Member

Fixed on main, and backported to the 3.11 and 3.10 branches.

Thanks @hauntsaninja for the PR, and thanks @Kentzo for originally pointing out the problem over at mypy!

@AlexWaygood AlexWaygood mentioned this issue Oct 31, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir topic-typing
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@hauntsaninja @AlexWaygood