Mailman 3 August 2013 - docs

[issue18676] Queue: document that zero is accepted as timeout value
by Terry J. Reedy 10 Aug '13

10 Aug '13

Changes by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- assignee: docs@python -> terry.reedy nosy: +terry.reedy stage: -> commit review _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18676> _______________________________________

1 0

Pedantic word change (http://docs.python.org/2/tutorial/classes.html#generators)
by Tama Pugsley 10 Aug '13

10 Aug '13

Hi there, I'm just getting started with Python (escaping PHP madness), thanks for writing such awesome documentation. Quick tense change here: http://docs.python.org/2/tutorial/classes.html 9.10. Generators "Another key feature is that the local variables and execution state are automatically saved between calls. This >>>made<<< the function easier to write and much more clear than an approach using instance variables like self.index and self.data." Should the second sentence start "This MAKES"? Cheers, Tama

1 0

Enhancement of faq/gui.html
by Madan Ram 10 Aug '13

10 Aug '13

"Qt 4.5 upwards is licensed under the LGPL license; also, commercial licenses are available from Nokia." Since new version of Qt 5 is realsed and Licenced under Digia. So i am fixing this issue . i am going to write it as PyQt5 is licensed on all platforms under a commercial license and the GPL v3. Your PyQt5 license must be compatible with your Qt license. If you use the GPL version then your own code must also use a compatible license. Note:-PyQt5, unlike Qt, is not available under the LGPL. You can purchase a commercial PyQt5 license here.

1 0

Improve tutorial entry on 'Lambda Forms'. (issue 18646)
by ezio.melotti＠gmail.com 10 Aug '13

10 Aug '13

http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst File Doc/tutorial/controlflow.rst (right): http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst#… Doc/tutorial/controlflow.rst:586: Lambda Forms "forms" could be changed here as well. http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst#… Doc/tutorial/controlflow.rst:589: Small anonymous functions can be created with the :keyword:`lambda` keyword. I prefer "simple", rather than "small". http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst#… Doc/tutorial/controlflow.rst:590: This function returns the sum of its two arguments: ``lambda a, b: a+b``. "For example, this function..."? http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst#… Doc/tutorial/controlflow.rst:591: Lambda forms can be used wherever function objects are required. They are I would get rid of "forms" here too. http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst#… Doc/tutorial/controlflow.rst:592: syntactically restricted to a single expression. Semantically, they are just Do we have an explanation of what an "expression" is somewhere? http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst#… Doc/tutorial/controlflow.rst:594: name attribute will always be '<lambda>'. Like nested function Is this the only difference? Maybe you could say: "... a normal function definition, except that their name attribute will always be '<lambda>'." (Also there's a missing space after the period.) http://bugs.python.org/review/18646/diff/8811/Doc/tutorial/controlflow.rst#… Doc/tutorial/controlflow.rst:612: [(4, 'four'), (1, 'one'), (3, 'three'), (2, 'two')] I think this example would make more sense if the elements of the tuples were swapped. A normal sort would sort them alphabetically, but with the lambda you can sort the tuples correctly. I would also put this example before the make_incrementor one, since this usage is more common. http://bugs.python.org/review/18646/

1 0

[issue18696] In unittest.TestCase.longMessage doc remove a redundant sentence
by py.user 10 Aug '13

10 Aug '13

New submission from py.user: http://docs.python.org/3/library/unittest.html#unittest.TestCase.longMessage "If set to True then any explicit failure message you pass in to the assert methods will be appended to the end of the normal failure message. The normal messages contain useful information about the objects involved, for example the message from assertEqual shows you the repr of the two unequal objects. Setting this attribute to True allows you to have a custom error message in addition to the normal one." the last sentence duplicates the first one ---------- assignee: docs@python components: Documentation files: issue.diff keywords: patch messages: 194748 nosy: docs@python, py.user priority: normal severity: normal status: open title: In unittest.TestCase.longMessage doc remove a redundant sentence type: enhancement versions: Python 3.3, Python 3.4 Added file: http://bugs.python.org/file31208/issue.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18696> _______________________________________

3 2

[issue18512] sys.stdout.write does not allow bytes in Python 3.x
by Ezio Melotti 10 Aug '13

10 Aug '13

Ezio Melotti added the comment: > You can do > sys.stdout.buffer.write(b"hello") Note that this might not work when sys.stdout has been replaced with something else (e.g. a StringIO). ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18512> _______________________________________

1 0

[issue18516] Typos in Lib/email/generator.py and Lib/email/architecture.rst
by Vajrasky Kok 10 Aug '13

10 Aug '13

New submission from Vajrasky Kok: [sky@localhost cpython]$ grep -n boudary Lib/email/generator.py 352: # _make_boudary = Generator._make_boundary [sky@localhost cpython]$ grep -n fuzy Lib/email/architecture.rst 27:This division is intentionally a bit fuzy; the API described by this documentation In addition to that, I found inconsistency in plural form of tuple. [sky@localhost cpython]$ grep -n "\-tuple" Lib/email/utils.py 79: """The inverse of parseaddr(), this takes a 2-tuple of the form 285: params is a sequence of 2-tuples containing (param name, string value). 291: # 3-tuple of the continuation number, the string value, and a flag But I think this issue is very very trivial and we can ignore it. ---------- assignee: docs@python components: Documentation messages: 193425 nosy: docs@python, r.david.murray, vajrasky priority: normal severity: normal status: open title: Typos in Lib/email/generator.py and Lib/email/architecture.rst versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18516> _______________________________________

3 3

MS Windows inconsistent advice in http://docs.python.org/2/install/index.html
by Roger Erens 09 Aug '13

09 Aug '13

In the line right above the section http://docs.python.org/2/install/index.html#splitting-the-job-up it is stated that on windows one should use python setup.py install whereas in the earlier section http://docs.python.org/2/install/index.html#the-new-standard-distutils it was stated that for windows this command should be setup.py install Thanks for the great docs on python.org!

1 0

[issue18600] email.policy doc example passes 'policy' to as_string, but that doesn't work
by R. David Murray 09 Aug '13

09 Aug '13

New submission from R. David Murray: When I wrote those docs I intended to add a policy argument to as_string, but did not do it by the time 3.3 was released. The docs for 3.3 need to be corrected, and I need to decide if I do want to add that keyword to as_string in 3.4 (the answer is probably yes, but I may check with the email-sig first). ---------- assignee: docs@python components: Documentation, email messages: 193937 nosy: barry, docs@python, r.david.murray priority: normal severity: normal stage: needs patch status: open title: email.policy doc example passes 'policy' to as_string, but that doesn't work type: behavior versions: Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18600> _______________________________________

2 3

email.policy doc example passes 'policy' to as_string, but that doesn't work (issue 18600)
by pitrou＠free.fr 09 Aug '13

09 Aug '13

http://bugs.python.org/review/18600/diff/8864/Doc/library/email.message.rst File Doc/library/email.message.rst (right): http://bugs.python.org/review/18600/diff/8864/Doc/library/email.message.rst… Doc/library/email.message.rst:43: .. method:: as_string(unixfrom=False, maxheaderlen=0, policy=None) You need a versionchanged tag for the new parameter. http://bugs.python.org/review/18600/diff/8864/Doc/library/email.message.rst… Doc/library/email.message.rst:85: .. method:: as_bytes(unixfrom=False, policy=None) versionadded required. http://bugs.python.org/review/18600/diff/8864/Doc/library/email.message.rst… Doc/library/email.message.rst:114: .. method:: __bytes__() versionadded required. http://bugs.python.org/review/18600/

1 0