Mailman 3 December 2010 - docs

[issue9767] Failures in json doc examples
by Terry J. Reedy Oct. 26, 2012

Oct. 26, 2012

New submission from Terry J. Reedy <tjreedy(a)udel.edu>: I ran doctest on LibRef 17.2 json saved as .txt. There are 4 failures: 2 are clearly doc issues, the other 2 I do not know. I hope someone reads this who is already familiar DOC PATCHES dumps(2 + 1j, cls=ComplexEncoder) should be json.dumps(2 + 1j, cls=ComplexEncoder) and JSONEncoder().encode({"foo": ["bar", "baz"]}) should be json.JSONEncoder().encode({"foo": ["bar", "baz"]}) Needing similar additions in example … [View More]

3 4

[issue10405] IDLE breakpoint facility undocumented
by Ned Deily Oct. 20, 2012

Oct. 20, 2012

New submission from Ned Deily <nad(a)acm.org>: In neither the IDLE section of the Library Reference nor in IDLE's own help file is there any documentation on how to use its breakpoint capability. Since the menu options only appear if the user knows to Right-click (or Control-click on OS X - see issue10404), it would be easy for a user to never realize that the breakpoint capability exists. ---------- assignee: docs@python components: Documentation, IDLE messages: 121121 nosy: docs@… [View More]

5 9

[issue10665] Update and expand unicodedata module documentation
by Alexander Belopolsky Sept. 26, 2012

Sept. 26, 2012

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: unicodedata module documentation has not been updated to reflect transition to 6.0. Attached patch fixes the version and unicode.org links and starts making the documentation rely less on the unicode.org pages for basic understanding of the provided functionality. I am posting work in progress to solicit feedback on how much of the Unicode Standard information we would want to present here. On of the goals … [View More]

6 25

[issue10376] ZipFile unzip is unbuffered
by James Hutchison June 23, 2012

June 23, 2012

New submission from James Hutchison <jamesghutchison(a)gmail.com>: The Unzip module is always unbuffered (tested v.3.1.2 Windows XP, 32-bit). This means that if one has to do many small reads it is a lot slower than reading a chunk of data to a buffer and then reading from that buffer. It seems logical that the unzip module should default to buffered reading and/or have a buffered argument. Likewise, the documentation should clarify that there is no buffering involved when doing a read, … [View More]

9 17

[issue8652] Minor improvements to the "Handling Exceptions" part of the tutorial
by Marien Zwart June 8, 2012

June 8, 2012

New submission from Marien Zwart <m_zwart(a)123mail.org>: Based on questions asked on freenode's #python by people reading the tutorial I would like to suggest two improvements to http://docs.python.org/tutorial/errors.html#handling-exceptions : - Mention the older "except SomeException, e:" syntax too, not just "except SomeException as e:". I have had people ask me to help them upgrade to a newer python because they thought their version of python did not support catching exception … [View More]

4 6

[issue8617] Non-existent variables documented
by Dave Abrahams May 9, 2012

May 9, 2012

New submission from Dave Abrahams <dave(a)boostpro.com>: http://docs.python.org/library/site.html#module-site mentions two variables that don't appear in my Python 2.6.5 installation's site module: PYTHONNOUSERSITE New in version 2.6. PYTHONUSERBASE New in version 2.6. ---------- assignee: docs@python components: Documentation messages: 104985 nosy: dabrahams, docs@python priority: normal severity: normal status: open title: Non-existent variables documented versions: Python 2.6 … [View More]

6 13

[issue10423] s/args/options in arpgarse "Upgrading optparse code"
by Steven Bethard March 30, 2012

March 30, 2012

New submission from Steven Bethard <steven.bethard(a)gmail.com>: >From a personal email: ---------------------------------------------------------------------- I'm not signed up for all the Python issue tracking stuff, but thought I'd let you know about a problem with the argparse doc page: http://docs.python.org/library/argparse.html It says at the end: Replace options, args = parser.parse_args() with args = parser.parse_args() and add additional ArgumentParser.… [View More]

5 8

[issue10713] re module doesn't describe string boundaries for \b
by Ralph Corderoy Feb. 29, 2012

Feb. 29, 2012

New submission from Ralph Corderoy <ralph-pythonbugs(a)inputplus.co.uk>: The re module defines \b in a regexp to need \w one side and \W the other. What about when the end of the string or line is involved? perlre(1) says that's treated as a \W. Python should precisely document that case too. ---------- assignee: docs@python components: Documentation messages: 124097 nosy: docs@python, ralph.corderoy priority: normal severity: normal status: open title: re module doesn't describe … [View More]

6 9

[issue9442] Update sys.version doc
by Éric Araujo Feb. 10, 2012

Feb. 10, 2012

New submission from Éric Araujo <merwok(a)netwok.org>: Attaching a patch to edit mention of “build number” in library/sys. I also don’t understand “The first three characters are used to identify the version in the installation directories (where appropriate on each platform)”, maybe someone who does could enlighten me. If #5778 is rejected, the doc will need another update to mention that there may be a newline in sys.version. ---------- assignee: docs@python components: … [View More]

4 9

[issue9021] no copy.copy problem description
by anatoly techtonik Feb. 9, 2012

Feb. 9, 2012

New submission from anatoly techtonik <techtonik(a)gmail.com>: `copy` module covers very important aspect of Python programming. However its documentation doesn't provide any intro or overview of this problem starting right from details. When people meet `copy` construction in the code - the refer to module documentation and its doesn't completely answer two basic questions they have: 1. why copy module is needed (i.e. what's the problem with var assignment) 2. when and where it should … [View More]

5 10