Mailman 3 August 2014 - docs

[issue17462] argparse FAQ: how it is different from optparse
by anatoly techtonik Sept. 26, 2014

Sept. 26, 2014

New submission from anatoly techtonik: http://stackoverflow.com/questions/3217673/why-use-argparse-rather-than-opt… Too many votes. This should be confirmed by the official documentation. ---------- assignee: docs@python components: Documentation messages: 184468 nosy: docs@python, techtonik priority: normal severity: normal status: open title: argparse FAQ: how it is different from optparse _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17462> _______________________________________

9 15

[issue21860] Correct FileIO docstrings
by Serhiy Storchaka Sept. 24, 2014

Sept. 24, 2014

New submission from Serhiy Storchaka: Docstrings for seek() and truncate() methods of FileIO declare that they return None. Actually they return truncated size and new position respectively. ---------- assignee: docs@python components: Documentation, IO keywords: easy messages: 221452 nosy: benjamin.peterson, docs@python, hynek, pitrou, serhiy.storchaka, stutzbach priority: normal severity: normal stage: needs patch status: open title: Correct FileIO docstrings type: behavior versions: Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21860> _______________________________________

5 7

[issue16827] Remove the relatively advanced content from section 2 in tutorial
by Ramchandra Apte Sept. 18, 2014

Sept. 18, 2014

New submission from Ramchandra Apte: Most of the content in section 2 in the tutorial, http://docs.python.org/3/tutorial/interpreter.html , is relatively advanced and doesn't belong in, at least, the beginning of the tutorial. Only 2.1. Invoking the Interpreter, and 2.2.3. Source Code Encoding should be in section 2. The rest can be moved outside the tutorial, or in later portions. Thanks to Ezio Melotti for helping me overcome my laziness in filing this bug. ---------- assignee: docs@python components: Documentation messages: 178680 nosy: docs@python, ramchandra.apte priority: normal severity: normal status: open title: Remove the relatively advanced content from section 2 in tutorial _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16827> _______________________________________

9 14

[issue14824] reprlib documentation references string module
by Jasper St. Pierre Sept. 18, 2014

Sept. 18, 2014

New submission from Jasper St. Pierre <jstpierre(a)mecheye.net>: http://docs.python.org/dev/library/reprlib.html """ Formatting methods for specific types are implemented as methods with a name based on the type name. In the method name, TYPE is replaced by string.join(string.split(type(obj).__name__, '_')). Dispatch to these methods is handled by repr1(). Type-specific methods which need to recursively format a value should call self.repr1(subobj, level - 1). """ Outstanding. ---------- assignee: docs@python components: Documentation messages: 160805 nosy: docs@python, magcius priority: normal severity: normal status: open title: reprlib documentation references string module versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14824> _______________________________________

5 8

[issue22224] docs.python.org is prone to political blocking in Russia
by Alexander Patrakov Sept. 12, 2014

Sept. 12, 2014

New submission from Alexander Patrakov: I could not access http://docs.python.org/ from work today. Upon investigation, it appears that the ISP has blocked all sites on the IP address 185.31.17.175, because of the court order unrelated to docs.python.org. Many other ISPs in Russia also don't know any methods of site blocking except by IP address. Even if the bad site removes the offending materials, the situation is doomed to repeat itself in the future. To avoid this, please obtain an IPv4 or IPv6 address for docs.python.org that is not shared with any site not controlled by PSF. ---------- assignee: docs@python components: Documentation messages: 225487 nosy: Alexander.Patrakov, docs@python priority: normal severity: normal status: open title: docs.python.org is prone to political blocking in Russia type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22224> _______________________________________

7 15

[issue20643] Strange dot in documentation (after generator.close)
by Vladimir Rutsky Sept. 5, 2014

Sept. 5, 2014

New submission from Vladimir Rutsky: In 3.4 docs after generator.close() description there is strange dot: http://docs.python.org/3.4/reference/expressions.html#generator.close Looks like it's due to following code in Doc/reference/expressions.rst:452: .. class:: . This line should be removed. ---------- assignee: docs@python components: Documentation messages: 211364 nosy: docs@python, rutsky priority: normal severity: normal status: open title: Strange dot in documentation (after generator.close) versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20643> _______________________________________

4 4

[issue19826] Document that bug reporting by email is possible
by anatoly techtonik Sept. 2, 2014

Sept. 2, 2014

New submission from anatoly techtonik: I found this to be convenient: http://techtonik.rainforce.org/2013/11/roundup-tracker-create-issues-by-ema… And this is missing from here: http://docs.python.org/release/2.7/bugs.html#using-the-python-issue-tracker Anf from here: http://docs.python.org/devguide/triaging.html Disclaimer: I didn't sign the CLA, and people keep telling me that I need it to do documentation edits. But I edit Wikipedia freely and I find it wrong that I can not edit Python documentation without signing papers. So I am not sending patches until either Wikipedia requires CLA to edit its contents, or PSF abandons its ill FUD policies in favor of creating collaborative environment. Regarding my aforementioned blog post, feel free to copy-paste it, as an author I release this into CC0/public domain. Ask python-legal-sig if it is enough. ---------- assignee: docs@python components: Documentation messages: 204693 nosy: docs@python, techtonik priority: normal severity: normal status: open title: Document that bug reporting by email is possible _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19826> _______________________________________

6 8

[issue22318] unitest documentation on assertItemsEqual misleading
by Tony Flury Sept. 1, 2014

Sept. 1, 2014

New submission from Tony Flury: The notes on assertItemsEqual do not make it clear that the comparison works by using their hash value, and not their __eq__ implementation - i.e. it does an 'is' not an '==' between objects in the sequence. If the sequences being compared contain user created objects which don't implement their own specific __hash__ method (and therefore inherit their __hash__ from the base object - based on the object id), then the assertion will ALWAYS be false, regardless of their __eq__ value. This only became clear when trying to use unitest, getting strange results, and I eventually read the code. ---------- assignee: docs@python components: Documentation messages: 226193 nosy: TonyFlury, docs@python priority: normal severity: normal status: open title: unitest documentation on assertItemsEqual misleading type: behavior versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22318> _______________________________________

2 2

[issue22316] Add rule about "extraneous whitespace around colon" to "Whitespace In Expressions and Statements" of PEP8
by Anthony Mayer Sept. 1, 2014

Sept. 1, 2014

New submission from Anthony Mayer: After discussion about extraneous whitespace around colons in a list slice not being an error on the pep8 checker project (see https://github.com/jcrocholl/pep8/issues/321#issuecomment-53649841), ncoghlan suggested filing a ticket here to get the issue added to PEP8. The issue being that PEP8 doesn't say that x = [1, 2, 3, 4] x[1: 3] is wrong. It should suggest doing x = [1, 2, 3, 4] x[1:3] instead. This rule should probably be added to the "Whitespace In Expressions and Statements" section of PEP8 (http://legacy.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-s…) ---------- assignee: docs@python components: Documentation messages: 226185 nosy: Guido.van.Rossum, anthonymayer, barry, docs@python, ncoghlan priority: normal severity: normal status: open title: Add rule about "extraneous whitespace around colon" to "Whitespace In Expressions and Statements" of PEP8 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22316> _______________________________________

4 6

[issue22275] asyncio: enhance documentation of OS support
by STINNER Victor Aug. 31, 2014

Aug. 31, 2014

New submission from STINNER Victor: When reading asyncio documentation, it's not easy to catch limitations of each operating system and event loop. I propose to mention in each mention if the method is not supported in some cases. See attached patch. ---------- assignee: docs@python components: Documentation, asyncio files: asyncio_os_support.patch keywords: patch messages: 225902 nosy: docs@python, gvanrossum, haypo, yselivanov priority: normal severity: normal status: open title: asyncio: enhance documentation of OS support versions: Python 3.4, Python 3.5 Added file: http://bugs.python.org/file36474/asyncio_os_support.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22275> _______________________________________

2 1