mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-08-04 17:08:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

gh-99026 update dataclasses docs for when annotations are inspected (gh-100798)

Browse source 
update dataclasses docs for when annotations are inspected
(cherry picked from commit 659c2607f5)

Co-authored-by: Akshit Tyagi <37214399+exitflynn@users.noreply.github.com>
This commit is contained in:
Miss Islington (bot) 2023-01-06 06:34:12 -08:00 • committed by GitHub
parent ebe8d23407
commit 8af15cfc8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Doc/library/dataclasses.rst
View file

@ -535,7 +535,7 @@ parameters to :meth:`__post_init__`. Also see the warning about how
Class variables
---------------
One of two places where :func:`dataclass` actually inspects the type
One of the few places where :func:`dataclass` actually inspects the type
of a field is to determine if a field is a class variable as defined
in :pep:`526`. It does this by checking if the type of the field is
``typing.ClassVar``. If a field is a ``ClassVar``, it is excluded
@ -546,7 +546,7 @@ module-level :func:`fields` function.
Init-only variables
-------------------
The other place where :func:`dataclass` inspects a type annotation is to
Another place where :func:`dataclass` inspects a type annotation is to
determine if a field is an init-only variable. It does this by seeing
if the type of a field is of type ``dataclasses.InitVar``. If a field
is an ``InitVar``, it is considered a pseudo-field called an init-only