[3.12] gh-130130: Clarify `hash=False` docs in `dataclasses.field` (GH-130324) (...

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

Co-authored-by: Sabfo <alpha.sabfo@gmail.com>

diff --git a/Doc/library/dataclasses.rst b/Doc/library/dataclasses.rst
index 87b532fb4f8357fe3dcf4ed1e51171582ca602f2..3151232588f53bcf30b8fdb7b4a25812388b9ef9 100644 (file)
--- a/Doc/library/dataclasses.rst
+++ b/Doc/library/dataclasses.rst
@@ -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``