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.

Author zach.ware
Recipients brian.curtin, docs@python, stutzbach, zach.ware
Date 2012-10-11.16:12:11
SpamBayes Score -1.0
Marked as misclassified Yes
Message-id <1349971931.7.0.721708893114.issue16197@psf.upfronthosting.co.za>
In-reply-to
Content
There are several small inconsistencies in the winreg module documentation (docstrings and winreg.rst).  Mostly these are discrepancies between "res" and "reserved", "sam" and "access", and whether or not those two are keyword arguments, but there are some other missing pieces as well.

I'm happy to provide a patch to correct everything, but I'd like a little guidance beforehand.  I have no experience with docstrings in C code, so I've attached a patch that attempts to correct just the CreateKeyEx() docstring.  If it turns out to be ok, I'll go ahead and create a patch fixing the other ones.  I'm comfortable enough with ReST changes that I'll just include those with the final docstring patch.

Also, some of the changes are specific to 3.3+ (due to the WindowsError => OSError change).  Should I provide one patch against default, two against 3.2 and 3.3 (including the 3.2 changes), or two against 3.2 and 3.3 (after a local commit of the 3.2 changes)?  Any of the above is perfectly doable :)

Thanks,

Zach
History
Date User Action Args
2012-10-11 16:12:11zach.waresetrecipients: + zach.ware, stutzbach, brian.curtin, docs@python
2012-10-11 16:12:11zach.waresetmessageid: <1349971931.7.0.721708893114.issue16197@psf.upfronthosting.co.za>
2012-10-11 16:12:11zach.warelinkissue16197 messages
2012-10-11 16:12:11zach.warecreate