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-132221: Fix __match_args__ generation docs in dataclasses.rst (#132222)

Browse source
This commit is contained in:
sobolevn 2025-04-07 17:46:47 +03:00 • committed by GitHub
parent e80ed2cf75
commit 8b62374b34
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
Doc/library/dataclasses.rst
View file

@ -164,7 +164,7 @@ Module contents
- *match_args*: If true (the default is ``True``), the
:attr:`~object.__match_args__` tuple will be created from the list of
parameters to the generated :meth:`~object.__init__` method (even if
non keyword-only parameters to the generated :meth:`~object.__init__` method (even if
:meth:`!__init__` is not generated, see above). If false, or if
:attr:`!__match_args__` is already defined in the class, then
:attr:`!__match_args__` will not be generated.
@ -175,11 +175,12 @@ Module contents
fields will be marked as keyword-only. If a field is marked as
keyword-only, then the only effect is that the :meth:`~object.__init__`
parameter generated from a keyword-only field must be specified
with a keyword when :meth:`!__init__` is called. There is no
effect on any other aspect of dataclasses. See the
:term:`parameter` glossary entry for details. Also see the
with a keyword when :meth:`!__init__` is called. See the :term:`parameter`
glossary entry for details. Also see the
:const:`KW_ONLY` section.
Keyword-only fields are not included in :attr:`!__match_args__`.
.. versionadded:: 3.10
- *slots*: If true (the default is ``False``), :attr:`~object.__slots__` attribute
@ -299,6 +300,8 @@ Module contents
This is used when the generated :meth:`~object.__init__` method's
parameters are computed.
Keyword-only fields are also not included in :attr:`!__match_args__`.
.. versionadded:: 3.10
- ``doc``: optional docstring for this field.