Repository navigation
Grammatical errors in weakref.WeakValueDictionary docs #73660
Description
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = 'https://github.com/Mariatta'
closed_at = <Date 2017-02-12.16:24:13.628>
created_at = <Date 2017-02-07.15:59:18.671>
labels = ['easy', '3.7', 'docs']
title = 'Grammatical errors in weakref.WeakValueDictionary docs'
updated_at = <Date 2017-03-25.00:49:38.946>
user = 'https://github.com/Mariatta'bugs.python.org fields:
activity = <Date 2017-03-25.00:49:38.946>
actor = 'zach.ware'
assignee = 'Mariatta'
closed = True
closed_date = <Date 2017-02-12.16:24:13.628>
closer = 'Mariatta'
components = ['Documentation']
creation = <Date 2017-02-07.15:59:18.671>
creator = 'Mariatta'
dependencies = []
files = ['46570', '46571', '46597']
hgrepos = []
issue_num = 29474
keywords = ['patch', 'easy']
message_count = 13.0
messages = ['287241', '287243', '287245', '287276', '287277', '287301', '287341', '287342', '287641', '290446', '290448', '290449', '290454']
nosy_count = 6.0
nosy_names = ['rhettinger', 'vstinner', 'docs@python', 'zach.ware', 'marco.buttu', 'Mariatta']
pr_nums = ['10', '22', '23', '11']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue29474'
versions = ['Python 2.7', 'Python 3.5', 'Python 3.6', 'Python 3.7']
Activity
Mariatta commentedon Feb 7, 2017
https://docs.python.org/3/library/weakref.html?highlight=weakref#weakref.WeakValueDictionary
There are grammatical errors in the sentence:
These method have the same issues as the and keyrefs() method of WeakKeyDictionary objects.
Reported by Arthur Goldberg in https://mail.python.org/pipermail/docs/2017-February/029957.html
vstinner commentedon Feb 7, 2017
Would you mind to propose a patch? Thanks in advance.
Note: the sentence is also wrong in Python 2.7 doc, no?
Mariatta commentedon Feb 7, 2017
You're right, Victor :)
The wording in 2.7 is a little bit different, but should be fixed too.
In 2.7:
These method have the same issues as the iterkeyrefs() and keyrefs() methods of WeakKeyDictionary objects.
Assigning this to myself.
Mariatta commentedon Feb 8, 2017
Attached is the patch to fix the grammatical errors for versions 3.5+
Mariatta commentedon Feb 8, 2017
And here is the patch that fixes the issue for python 2.7.
marco-buttu commentedon Feb 8, 2017
The second patch LGTM. In the first one there is a typo (see review).
Mariatta commentedon Feb 8, 2017
Thanks for reviewing, Marco :)
Updated the patch.
marco-buttu commentedon Feb 8, 2017
Thanks Mariatta, now it is OK to me
Mariatta commentedon Feb 12, 2017
Thanks, everyone :)
The GitHub PRs have been merged.
Closing this issue.
Mariatta commentedon Mar 25, 2017
New changeset 3110a37 by Mariatta in branch 'master':
bpo-29474: Improve documentation for weakref.WeakValueDictionary (#10)
3110a37
Mariatta commentedon Mar 25, 2017
New changeset 308f789 by Mariatta in branch '3.6':
bpo-29474: Improve documentation for weakref.WeakValueDictionary (#22)
308f789
Mariatta commentedon Mar 25, 2017
New changeset ae82871 by Mariatta in branch '3.5':
bpo-29474: Improve documentation for weakref.WeakValueDictionary (#23)
ae82871
zware commentedon Mar 25, 2017
New changeset 5c32988 by Zachary Ware (Mariatta) in branch '2.7':
bpo-29474: Improve documentation for weakref.WeakValueDictionary (#11)
5c32988