gh-137900: Improve dataclasses frozen parameter documentation (#137937)

This commit is contained in:
Tangyuan 2025-08-20 21:08:45 +08:00 committed by GitHub
parent 23adbf53c5
commit 7685b8ada8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -161,9 +161,11 @@ Module contents
:class:`object`, this means it will fall back to id-based hashing).
- *frozen*: If true (the default is ``False``), assigning to fields will
generate an exception. This emulates read-only frozen instances. If
:meth:`~object.__setattr__` or :meth:`~object.__delattr__` is defined in the class, then
:exc:`TypeError` is raised. See the discussion below.
generate an exception. This emulates read-only frozen instances.
See the :ref:`discussion <dataclasses-frozen>` below.
If :meth:`~object.__setattr__` or :meth:`~object.__delattr__` is defined in the class
and *frozen* is true, then :exc:`TypeError` is raised.
- *match_args*: If true (the default is ``True``), the
:attr:`~object.__match_args__` tuple will be created from the list of