https://github.com/python/cpython/commit/47ace539950fb675d5968736348f0d724ba199f0
commit: 47ace539950fb675d5968736348f0d724ba199f0
branch: main
author: Sabfo <alpha.sa...@gmail.com>
committer: ericvsmith <ericvsm...@users.noreply.github.com>
date: 2025-02-20T02:43:27-05:00
summary:
gh-130130: Clarify `hash=False` docs in `dataclasses.field` (#130324)
files:
M Doc/library/dataclasses.rst
diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst
index e34b2db0210960..f63a01e9570791 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``
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
