[issue46013] Confusing period in object.__hash__ doc
New submission from JMcB <joel.mcbride1@live.com>: At https://docs.python.org/3/reference/datamodel.html#object.__hash__ It says: Called by built-in function hash() and for operations on members of hashed collections including set, frozenset, and dict. __hash__() should return an integer. How it's rendered there, the kerning made it confusing to me on a first read because dict. [new sentence]__hash__() looked like dict.__hash__(). I think a line break should be added, which I'll open a pr to do. ---------- assignee: docs@python components: Documentation messages: 408014 nosy: JMcB17, docs@python priority: normal severity: normal status: open title: Confusing period in object.__hash__ doc type: enhancement versions: Python 3.10 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Change by JMcB <joel.mcbride1@live.com>: ---------- keywords: +patch pull_requests: +28212 stage: -> patch review pull_request: https://github.com/python/cpython/pull/29989 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Raymond Hettinger <raymond.hettinger@gmail.com> added the comment: A line break would look weird. Let's add plain English instead. - including set, frozenset, and dict. __hash__() should return an integer. + including set, frozenset, and dict. The __hash__() method should return an integer. ---------- nosy: +rhettinger _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Change by Alex Waygood <Alex.Waygood@Gmail.com>: ---------- nosy: +AlexWaygood _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Irit Katriel <iritkatriel@gmail.com> added the comment: New changeset 3af68fc77c528d4e7749046cf6e41fd79902e6e6 by jmcb in branch 'main': bpo-46013: Fix confusing kerning on period in docs (GH-29989) https://github.com/python/cpython/commit/3af68fc77c528d4e7749046cf6e41fd7990... ---------- nosy: +iritkatriel _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- nosy: +miss-islington nosy_count: 5.0 -> 6.0 pull_requests: +30093 pull_request: https://github.com/python/cpython/pull/32005 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +30094 pull_request: https://github.com/python/cpython/pull/32006 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Irit Katriel <iritkatriel@gmail.com> added the comment: New changeset 87b3e202d46cdeb0a6b1ef041579a5ebc7c826a9 by Miss Islington (bot) in branch '3.10': bpo-46013: Fix confusing kerning on period in docs (GH-29989) (GH-32005) https://github.com/python/cpython/commit/87b3e202d46cdeb0a6b1ef041579a5ebc7c... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Irit Katriel <iritkatriel@gmail.com> added the comment: New changeset 504973a13336d8a4d20459f68de9647a1fb25966 by Miss Islington (bot) in branch '3.9': bpo-46013: Fix confusing kerning on period in docs (GH-29989) (GH-32006) https://github.com/python/cpython/commit/504973a13336d8a4d20459f68de9647a1fb... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
Change by Irit Katriel <iritkatriel@gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue46013> _______________________________________
participants (5)
-
Alex Waygood -
Irit Katriel
-
JMcB
-
miss-islington
-
Raymond Hettinger