mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-07-22 02:35:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.13] gh-130130: Clarify hash=False docs in dataclasses.field (GH-130324) (#130337)

Browse source 
gh-130130: Clarify `hash=False` docs in `dataclasses.field` (GH-130324)
(cherry picked from commit 47ace53995)

Co-authored-by: Sabfo <alpha.sabfo@gmail.com>
This commit is contained in:
Miss Islington (bot) 2025-02-20 08:51:39 +01:00 • committed by GitHub
parent 439cba75d9
commit 6041dba911
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/library/dataclasses.rst
View file

@ -277,10 +277,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``