From: sobolevn Date: Mon, 7 Apr 2025 14:46:47 +0000 (+0300) Subject: gh-132221: Fix `__match_args__` generation docs in `dataclasses.rst` (#132222) X-Git-Tag: v3.14.0a7~22 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=8b62374b344f5da852bed9f16619736d4d43936b;p=thirdparty%2FPython%2Fcpython.git gh-132221: Fix `__match_args__` generation docs in `dataclasses.rst` (#132222) --- diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst index f63a01e95707..0bc171da4eef 100644 --- a/Doc/library/dataclasses.rst +++ b/Doc/library/dataclasses.rst @@ -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.