classification
Title: dictnotes.txt is out of date
Type: enhancement Stage: resolved
Components: Documentation Versions: Python 3.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: Mark.Shannon, docs@python, pitrou, python-dev, rhettinger
Priority: normal Keywords: patch

Created on 2012-06-13 15:34 by Mark.Shannon, last changed 2012-06-24 19:13 by Mark.Shannon. This issue is now closed.

Files
File name Uploaded Description Edit
dictnotes.patch Mark.Shannon, 2012-06-13 15:34 Patch to revision 26e2ee402a0b review
Messages (7)
msg162709 - (view) Author: Mark Shannon (Mark.Shannon) * (Python committer) Date: 2012-06-13 15:34
dictnotes.txt is out of date w.r.t. dictobject.c

Remove notes from dictnotes.txt that duplicate comments in dictobject.c
and ensure comments in dictobject.c cover all aspects of tunable parameters.

Patch attached.
msg162710 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2012-06-13 16:12
Mark, where was it approved that you could change all the tunable parameters?  I remembered that the split dict was approved but not changing all of the tuneables (at one point, I had spent a month validating that the tuneables were correct across a wide variety of applications).
msg162711 - (view) Author: Mark Shannon (Mark.Shannon) * (Python committer) Date: 2012-06-13 16:32
Raymond,

I don't think this is the place to discuss the changes to the tunables in dictobject.c.

This patch merely ensures that dictnotes.txt and the comments in dictobject.c are in agreement. It doesn't change any code (apart from creating the GROWTH_RATE macro for clarity).
msg163820 - (view) Author: Mark Shannon (Mark.Shannon) * (Python committer) Date: 2012-06-24 19:02
Is there any reason not to commit this patch?
The docs are out of sync with the code and need to be updated.
msg163821 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-06-24 19:07
New changeset 1120041f2df4 by Antoine Pitrou in branch 'default':
Issue #15055: update dictnotes.txt.  Patch by Mark Shannon.
http://hg.python.org/cpython/rev/1120041f2df4
msg163822 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2012-06-24 19:08
Sorry, Mark. This is committed now.
msg163823 - (view) Author: Mark Shannon (Mark.Shannon) * (Python committer) Date: 2012-06-24 19:13
No apology needed :)
Thanks.
History
Date User Action Args
2012-06-24 19:13:47Mark.Shannonsetmessages: + msg163823
2012-06-24 19:08:33pitrousetstatus: open -> closed

assignee: rhettinger ->

nosy: + pitrou
messages: + msg163822
resolution: fixed
stage: resolved
2012-06-24 19:07:30python-devsetnosy: + python-dev
messages: + msg163821
2012-06-24 19:02:45Mark.Shannonsetmessages: + msg163820
2012-06-13 16:32:42Mark.Shannonsetmessages: + msg162711
2012-06-13 16:12:38rhettingersetmessages: + msg162710
2012-06-13 16:00:08rhettingersetassignee: docs@python -> rhettinger

nosy: + rhettinger
2012-06-13 15:34:13Mark.Shannoncreate