From: Sabfo Date: Thu, 20 Feb 2025 07:43:27 +0000 (+0200) Subject: gh-130130: Clarify `hash=False` docs in `dataclasses.field` (#130324) X-Git-Tag: v3.14.0a6~347 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=47ace539950fb675d5968736348f0d724ba199f0;p=thirdparty%2FPython%2Fcpython.git gh-130130: Clarify `hash=False` docs in `dataclasses.field` (#130324) --- diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst index e34b2db02109..f63a01e95707 100644 --- a/Doc/library/dataclasses.rst +++ b/Doc/library/dataclasses.rst @@ -270,10 +270,11 @@ Module contents string returned by the generated :meth:`~object.__repr__` method. - *hash*: This can be a bool or ``None``. If true, this field is - included in the generated :meth:`~object.__hash__` method. If ``None`` (the - default), use the value of *compare*: this would normally be - the expected behavior. A field should be considered in the hash - if it's used for comparisons. Setting this value to anything + included in the generated :meth:`~object.__hash__` method. If false, + this field is excluded from the generated :meth:`~object.__hash__`. + If ``None`` (the default), use the value of *compare*: this would + normally be the expected behavior, since a field should be included + in the hash if it's used for comparisons. Setting this value to anything other than ``None`` is discouraged. One possible reason to set ``hash=False`` but ``compare=True``