Mailman 3 September 2014 - docs

[issue9694] argparse required arguments displayed under "optional arguments"
by Oliver Smith 02 Sep '14

02 Sep '14

Oliver Smith added the comment: The term "optional arguments" is a poorly formed adjectival suffix of "option". What it's trying to say is "these are kwargs" rather than "these arguments are not compulsory". I ran into this issue with 3.4 and was looking to file a simple change request: In early DOS/Linux days we called these "switches". I suggest we simply change the default wording from "optional arguments" to "switches". ---------- nosy: +Oliver.Smith Added file: http://bugs.python.org/file36528/parrot.py _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9694> _______________________________________

1 0

[issue19826] Document that bug reporting by email is possible
by anatoly techtonik 02 Sep '14

02 Sep '14

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

[issue22154] ZipFile.open context manager support
by Mike Short 01 Sep '14

01 Sep '14

Mike Short added the comment: Context manager comment & code snippet added to zipfile doc - patch attached. ---------- keywords: +patch nosy: +Mike.Short Added file: http://bugs.python.org/file36521/zipfile.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22154> _______________________________________

1 0

[issue10240] dict.update.__doc__ is misleading
by Raymond Hettinger 01 Sep '14

01 Sep '14

Changes by Raymond Hettinger <raymond.hettinger(a)gmail.com>: ---------- resolution: -> rejected status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10240> _______________________________________

1 0

[issue22320] Invalid link in General Python FAQ
by Hideaki Muranami 01 Sep '14

01 Sep '14

New submission from Hideaki Muranami: Link of "Developer FAQ" on https://docs.python.org/3.4/faq/general.html#how-do-i-obtain-a-copy-of-the-… is invalid. ---------- assignee: docs@python components: Documentation messages: 226199 nosy: docs@python, mnamihdk priority: normal severity: normal status: open title: Invalid link in General Python FAQ versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22320> _______________________________________

5 9

[issue22318] unitest documentation on assertItemsEqual misleading
by Tony Flury 01 Sep '14

01 Sep '14

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 01 Sep '14

01 Sep '14

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