This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Confusing period in object.__hash__ doc
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.10
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: docs@python Nosy List: AlexWaygood, JMcB17, docs@python, iritkatriel, miss-islington, rhettinger
Priority: normal Keywords: patch

Created on 2021-12-08 12:37 by JMcB17, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 29989 merged JMcB17, 2021-12-08 12:40
PR 32005 merged miss-islington, 2022-03-20 09:58
PR 32006 merged miss-islington, 2022-03-20 09:58
Messages (5)
msg408014 - (view) Author: JMcB (JMcB17) * Date: 2021-12-08 12:37
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.
msg408036 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2021-12-08 16:31
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.
msg415600 - (view) Author: Irit Katriel (iritkatriel) * (Python committer) Date: 2022-03-20 09:58
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/3af68fc77c528d4e7749046cf6e41fd79902e6e6
msg415602 - (view) Author: Irit Katriel (iritkatriel) * (Python committer) Date: 2022-03-20 12:17
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/87b3e202d46cdeb0a6b1ef041579a5ebc7c826a9
msg415603 - (view) Author: Irit Katriel (iritkatriel) * (Python committer) Date: 2022-03-20 12:18
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/504973a13336d8a4d20459f68de9647a1fb25966
History
Date User Action Args
2022-04-11 14:59:53adminsetgithub: 90171
2022-03-20 12:18:23iritkatrielsetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2022-03-20 12:18:05iritkatrielsetmessages: + msg415603
2022-03-20 12:17:33iritkatrielsetmessages: + msg415602
2022-03-20 09:58:25miss-islingtonsetpull_requests: + pull_request30094
2022-03-20 09:58:22miss-islingtonsetnosy: + miss-islington
pull_requests: + pull_request30093
2022-03-20 09:58:16iritkatrielsetnosy: + iritkatriel
messages: + msg415600
2021-12-11 01:12:04AlexWaygoodsetnosy: + AlexWaygood
2021-12-08 16:31:10rhettingersetnosy: + rhettinger
messages: + msg408036
2021-12-08 12:40:31JMcB17setkeywords: + patch
stage: patch review
pull_requests: + pull_request28212
2021-12-08 12:37:28JMcB17create