Mailman 3 August 2013 - docs

[issue14101] example function in tertools.count is misindented
by Zbyszek Szmek Oct. 6, 2013

Oct. 6, 2013

New submission from Zbyszek Szmek <zbyszek(a)in.waw.pl>: Indentation is broken. diff --git a/Modules/itertoolsmodule.c b/Modules/itertoolsmodule.c --- a/Modules/itertoolsmodule.c +++ b/Modules/itertoolsmodule.c @@ -3221,10 +3221,10 @@ Return a count object whose .__next__() method returns consecutive values.\n\ Equivalent to:\n\n\ def count(firstval=0, step=1):\n\ - x = firstval\n\ - while 1:\n\ - yield x\n\ - x += step\n"); + x = firstval\n\ + while 1:\n\ + yield x\n\ + x += step\n"); ---------- assignee: docs@python components: Documentation, Library (Lib) files: itertools-count-indentation.diff keywords: patch messages: 154084 nosy: docs@python, zbysz priority: normal severity: normal status: open title: example function in tertools.count is misindented type: enhancement versions: Python 3.3 Added file: http://bugs.python.org/file24618/itertools-count-indentation.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14101> _______________________________________

4 3

/3/library/argparse.html#module-argparse
by Micheal Wells Oct. 6, 2013

Oct. 6, 2013

An observation: In example 16.4.1, a script named 'prog.py' is given, and the user is told that they may execute it from the command line like so: $ prog.py My issue with this, is that it doesn't mention that the script starts with a shebang or is made executable with chmod +x, and even then the command would be $ ./prog.py. A minor gripe, but I think that too much is assumed of the reader. For reference: Assuming the Python code above is saved into a file called prog.py, it can be run at the command line and provides useful help messages: $ prog.py -h

2 1

Trivial os.path documentation bug
by Neil Bushong Oct. 6, 2013

Oct. 6, 2013

Tiny typo: in the Python 3.3 os.makedirs documentation at http://docs.python.org/3.3/library/os.html#os.makedirs, the sentence saying "If exist*s*_ok is False (the default), an OSError is raised..." refers to the keyword argument as "exists_ok" (with an "s"), while the other parts refer to the keyword parameter as "exist_ok" (without the "s"). Thanks for providing and maintaining all the excellent documentation. Neil

2 1

bug in ipaddress module documentation
by Tom Kalt Oct. 6, 2013

Oct. 6, 2013

There is a slight problem with the documentation for the ipaddress module (http://docs.python.org/3.4/library/ipaddress.html). In section 21.28.2.3.1, operators such as <, <=, ==, != are called "logical operators." They should be called "relational operators." http://en.wikipedia.org/wiki/Relational_operator. Alternatively, sometimes they are called "comparison operators." By contrast, "logical operator" refers to and, or, xor, etc. I hope this helps. Tom Kalt ________________________________ This transmission may contain information that is privileged, confidential, and/or exempt from disclosure under applicable law. If you are not the intended recipient, you are hereby notified that any disclosure, copying, distribution, or use of the information contained herein (including any reliance thereon) is STRICTLY PROHIBITED. If you received this transmission in error, please immediately contact the sender and destroy the material in its entirety, whether in electronic or hard copy format.

2 1

2.7.3 documentation: "6.4.1. Importing * From a Package" sounds/ should be sound/
by John Bokma Oct. 6, 2013

Oct. 6, 2013

http://docs.python.org/2/tutorial/modules.html "the file sounds/effects/__init__.py " ^ should be sound, not sounds. Regards, John

2 1

platform.win32_ver() returns more than (version, csd, ptype)
by Andrew Berg Oct. 6, 2013

Oct. 6, 2013

http://docs.python.org/3.3/library/platform.html#platform.win32_ver The documentation explicitly states that platform.win32_ver() returns (version, csd, ptype), but in fact, it returns (release, version, csd, ptype). On Windows 8 (Python 3.3 of course): >>> platform.win32_ver() ('post2008Server', '6.2.9200', '', 'Multiprocessor Free')

2 1

Typo in example code for operator.attrgetter
by Jonathan Kamens Oct. 6, 2013

Oct. 6, 2013

At http://docs.python.org/2/library/operator.html#operator.attrgetter, the example code in one instance "resolve_att" where it should be "resolve_attr". Regards, Jonathan Kamens

2 1

[issue15432] gzip.py: mtime argument only since python 2.7
by Geir Ove Myhr Oct. 6, 2013

Oct. 6, 2013

New submission from Geir Ove Myhr <gomyhr(a)gmail.com>: In the gzip documentation (http://docs.python.org/library/gzip.html) a note should be added that the mtime option was added in Python 2.7. The patch which adds the option (http://svn.python.org/view?view=revision&revision=68319) is not included in Python 2.6.5. ---------- assignee: docs@python components: Documentation messages: 166214 nosy: docs@python, gomyhr priority: normal severity: normal status: open title: gzip.py: mtime argument only since python 2.7 versions: Python 2.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15432> _______________________________________

2 2

[issue15228] os.utime() docs not clear on behavior on nonexistant files
by Daniel Grace Oct. 6, 2013

Oct. 6, 2013

New submission from Daniel Grace <thisgenericname(a)gmail.com>: The documentation for os.utime() at http://docs.python.org/py3k/library/os.html#os.utime states: "Set the access and modified times of the file specified by path. [...] The effect is similar to running the Unix program touch on the path.)" Unlike 'touch', os.utime() will not create an empty file if called on a file that does not exist. IMO the current behavior is correct, but the comparison of os.utime() to touch implies that it would create empty files. I suggest clarifying the documentation to emphasize that os.utime() will not create new files and raises OSError in the event that the file does not exist. ---------- assignee: docs@python components: Documentation messages: 164422 nosy: dewin, docs@python priority: normal severity: normal status: open title: os.utime() docs not clear on behavior on nonexistant files type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15228> _______________________________________

4 4

[issue11807] Documentation of add_subparsers lacks information about parametres
by Filip Gruszczyński Oct. 6, 2013

Oct. 6, 2013

New submission from Filip Gruszczyński <gruszczy(a)gmail.com>: In argparse documentation parametres of add_subparsers are not listed. And yet there are some really useful parametres like parser_class. It would be useful, it they were described there well and one wouldn't have to look into the code to find them :-) I'll be happy to provide documentation patch tomorrow. ---------- assignee: docs@python components: Documentation messages: 133379 nosy: docs@python, gruszczy priority: normal severity: normal status: open title: Documentation of add_subparsers lacks information about parametres versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11807> _______________________________________

3 8