Mailman 3 July 2016 - docs

[issue10225] Fix doctest runable examples in python manual
by Berker Peksag 13 Jul '16

13 Jul '16

Changes by Berker Peksag <berker.peksag(a)gmail.com>: ---------- nosy: +andymaier, belopolsky, docs@python, eric.araujo, ezio.melotti, georg.brandl, lukasz.langa, rhettinger, terry.reedy -lissacoffeyx _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10225> _______________________________________

1 0

[issue27481] Replace TypeError with ValueError in doc regarding "embedded NUL character"
by Xiang Zhang 12 Jul '16

12 Jul '16

New submission from Xiang Zhang: Errors regarding "embedded NUL character" were changed from TypeError to ValueError, in r92365, issue22215, but the doc doesn't get updated. Add a patch to apply the change in doc. ---------- assignee: docs@python components: Documentation files: null_characters_doc.patch keywords: patch messages: 270164 nosy: docs@python, serhiy.storchaka, xiang.zhang priority: normal severity: normal status: open title: Replace TypeError with ValueError in doc regarding "embedded NUL character" versions: Python 3.6 Added file: http://bugs.python.org/file43685/null_characters_doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27481> _______________________________________

3 8

[issue13402] Document absoluteness of sys.executable
by Éric Araujo 12 Jul '16

12 Jul '16

New submission from Éric Araujo <merwok(a)netwok.org>: I wanted to know if sys.executable was always an absolute path but the doc does not talk about that. (My use case is that I’d like to reload a process and I wonder if I can call os.execve or if I need to use os.execvpe.) ---------- assignee: docs@python components: Documentation messages: 147609 nosy: docs@python, eric.araujo priority: normal severity: normal status: open title: Document absoluteness of sys.executable versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13402> _______________________________________

11 21

[issue26608] RLock undocumented behavior in case of multiple acquire
by Mateusz 12 Jul '16

12 Jul '16

New submission from Mateusz: The number of acquisitions must be the same as the number of releases or else lock will not be released for other threads leading to deadlock. This is not mentioned in documentation. First acquisition returns boolean and further acquisitions return 1. This is also not mentioned in documentation. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 262165 nosy: docs@python, smbrd priority: normal severity: normal status: open title: RLock undocumented behavior in case of multiple acquire versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26608> _______________________________________

3 2

[issue27464] Document that SplitResult & friends are namedtuples
by Raymond Hettinger 11 Jul '16

11 Jul '16

Changes by Raymond Hettinger <raymond.hettinger(a)gmail.com>: ---------- assignee: docs@python -> rhettinger _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27464> _______________________________________

1 0

[issue25523] Correct "a" article to "an" article
by Martin Panter 11 Jul '16

11 Jul '16

New submission from Martin Panter: This patch generally changes “a” to “an” where appropriate in the main documentation, doc strings, source code comments, and a couple error messages in the test suite. Since it touches so many files, I thought it would be good to get a quick review. ---------- assignee: docs@python components: Documentation files: a-an.patch keywords: patch messages: 253784 nosy: docs@python, martin.panter priority: normal severity: normal stage: patch review status: open title: Correct "a" article to "an" article versions: Python 3.4, Python 3.5, Python 3.6 Added file: http://bugs.python.org/file40909/a-an.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25523> _______________________________________

6 18

[issue27464] Document that SplitResult & friends are namedtuples
by Martin Panter 11 Jul '16

11 Jul '16

Martin Panter added the comment: I agree, SplitResult._replace() would probably have been very useful to me in the past if it were available (and guaranteed by the documentation). The namedtuple implementation was added in revision 79579fa8d752 (in 2.6 and 3.0), with a comment mentioning speeding up and simplifying the code. So it may not have originally been intended to have the namedtuple functionality as part of the API. If the change is made in 3.5, it should equally be made in 2.7 (with a notice about only being supported since 2.6). ---------- nosy: +martin.panter, rhettinger _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27464> _______________________________________

1 0

[issue10697] host and port attributes not documented well in function urllib.parse.urlparse and urlsplit
by Martin Panter 11 Jul '16

11 Jul '16

Changes by Martin Panter <vadmium+py(a)gmail.com>: ---------- status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10697> _______________________________________

1 0

[issue26176] EmailMessage example doesn't work
by Srujan Chaitanya 10 Jul '16

10 Jul '16

New submission from Srujan Chaitanya: Example provided in 19.1.14.1. Examples using the Provisional API at https://docs.python.org/3.4/library/email-examples.html?highlight=email%20e… Doesn't work. This could be a EmailMessage class issue also? ---------- assignee: docs@python components: Documentation messages: 258781 nosy: Srujan Chaitanya, docs@python priority: normal severity: normal status: open title: EmailMessage example doesn't work type: behavior versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26176> _______________________________________

9 10

Fix tkinter examples to be PEP8 compliant (issue 27455)
by senthil＠uthcode.com 09 Jul '16

09 Jul '16

I reviewed the version 3 of the patch. The changes look good to me. It can be committed. http://bugs.python.org/review/27455/

1 0