diff options
author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2023-01-06 14:34:12 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-06 14:34:12 (GMT) |
commit | 8af15cfc8eb2fe9584d441260743a53e0d74eb57 (patch) | |
tree | 26e11f49de514510b4ab96e102bfb6278ebccd34 /Doc | |
parent | ebe8d2340733a36fd7555e1c75bb103d9ef465ec (diff) | |
download | cpython-8af15cfc8eb2fe9584d441260743a53e0d74eb57.zip cpython-8af15cfc8eb2fe9584d441260743a53e0d74eb57.tar.gz cpython-8af15cfc8eb2fe9584d441260743a53e0d74eb57.tar.bz2 |
gh-99026 update dataclasses docs for when annotations are inspected (gh-100798)
update dataclasses docs for when annotations are inspected
(cherry picked from commit 659c2607f5b44a8a18a0840d1ac39df8a3219dd5)
Co-authored-by: Akshit Tyagi <37214399+exitflynn@users.noreply.github.com>
Diffstat (limited to 'Doc')
-rw-r--r-- | Doc/library/dataclasses.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst index add6043..5b3e831 100644 --- a/Doc/library/dataclasses.rst +++ b/Doc/library/dataclasses.rst @@ -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 |