Mailman 3 June 2010 - docs

[issue8983] Docstrings should refer to help(name), not name.__doc__
by Alexander Belopolsky Aug. 16, 2010

Aug. 16, 2010

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: Inspired by issue issue8973, I did $ grep -in "see.*\.__doc__" Modules/*.c Surprisingly, there were not as many results as I feared. As I explained in the referenced issue, "See name.__doc__", while technically correct, is not user friendly. If you copy name.__doc__ to >>> prompt, you get an ugly repr of a multiline string. I suggest s/name.__doc__/help(struct)/. Here are the grep results … [View More]

3 6

[issue8834] Define order of Misc/ACKS entries
by Alexander Belopolsky Aug. 10, 2010

Aug. 10, 2010

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: This is a semi-serious feature request following a brief discussion on #python-dev IRC. Brett Cannon pointed out on python-checkins list [1] that the names should be alphabetized. However, given that the names are international, it is not obvious what it means. I propose to add a comment at the top of Misc/ACKS that the list is maintained in "rough alphabetical order" but not define it any further. [1] … [View More]

6 10

[issue9037] Add explanation as to how to raise a custom exception in the extending python intermezzo on exceptions
by Jonathan G. Underwood Aug. 2, 2010

Aug. 2, 2010

New submission from Jonathan G. Underwood <jonathan.underwood(a)gmail.com>: In the documentation section on Extending Python with C or C++ there is an Intermezzo on Errors and Exceptions which shows how to create a custom exception in an extension module. I was just following these instructions for the first time and got to the end and was left wondering how to actually raise the custom exception in my new module, and it wasn't immediately obvious, so I propose to add a brief explanation … [View More]

2 1

[issue8562] hasattr(open, 'newlines') example gives incorrect results from PEP0278
by AdamN Aug. 2, 2010

Aug. 2, 2010

New submission from AdamN <adam(a)varud.com>: This bug from the Ubuntu list is being moved here: https://bugs.launchpad.net/ubuntu/+source/python-defaults/+bug/570737 Newlines support is enabled on Ubuntu but the example from: http://www.python.org/dev/peps/pep-0278/ Does not give the correct results (of True): if hasattr(open, 'newlines'): print 'We have universal newline support' I don't know if this is a documentation problem or whether there is another attr that … [View More]

4 3

[issue9106] remove numbers from 3-.. level entries in docs toc
by anatoly techtonik Aug. 2, 2010

Aug. 2, 2010

New submission from anatoly techtonik <techtonik(a)gmail.com>: It seems that left side ToC menu will be more clear without numeric prefixes from chapter on 3-.. nesting levels. How about to remove them? For example - the ToC menu now starting from root level: 15.6. logging — Logging facility for Python * 15.6.1. Logging tutorial o 15.6.1.1. Simple examples o 15.6.1.2. Loggers o 15.6.1.3. Handlers o 15.6.1.4. Formatters o 15.6.1.5. … [View More]

6 12

[issue8602] documentation of bz2 module mildly erroneous
by Matt Wartell Aug. 1, 2010

Aug. 1, 2010

New submission from Matt Wartell <matt.wartell+pt(a)gmail.com>: This is related to http://bugs.python.org/issue8601 "bz2.BZ2File should support "with" protocol per PEP 343" The documentation at http://docs.python.org/library/bz2.html states: "This module provides a comprehensive interface for the bz2 compression library. It implements a complete file interface,..." although bz2.BZ2File does not support the __enter__ and __exit__ methods so arguably doesn't implement the "complete … [View More]

3 5

[issue8638] Remove suggestion for name mangling from the tutorial
by Lucian Ursu July 31, 2010

July 31, 2010

New submission from Lucian Ursu <lucian_ursu(a)yahoo.com>: I suggest that name mangling should not be recommended as a way of having private attributes. Instead, one underscore should be suggested as a signal that the attribute is private. This suggestion comes after discussing with some of the helpers from #python. Basically, they said that name mangling should never be used, so it would be appropriate to remove this recommendation from the tutorial. ---------- assignee: docs@python … [View More]

8 8

[issue3874] documentation bug: HTMLParser needs to document unknown_decl
by Terry J. Reedy July 27, 2010

July 27, 2010

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: I understand that getting no response to a submission is not pleasant. I do not like it either. That is partly why I have started reviewing old issues. In the past couple of weeks, I have gotten old two orphaned patches applied by updating the headers, reading the patch, and adding a first-response approval message that got the attention of someone with code-commit privileges. I hope you agree that late is better than never. I just … [View More]

2 1

[issue8888] Promote SafeConfigParser and warn about ConfigParser
by Éric Araujo July 25, 2010

July 25, 2010

New submission from Éric Araujo <merwok(a)netwok.org>: Problems like #8880 could be prevented with a deprecation notice for the ConfigParser class, in favor of SafeConfigParser. (Not sure if R. David Murray meant just a recommendation or a real deprecation.) ---------- assignee: docs@python components: Documentation messages: 106943 nosy: docs@python, merwok, r.david.murray priority: normal severity: normal status: open title: Promote SafeConfigParser and warn about ConfigParser … [View More]

3 2

[issue9007] CGIHTTPServer
by anatoly techtonik July 21, 2010

July 21, 2010

New submission from anatoly techtonik <techtonik(a)gmail.com>: CGIHTTPServer only supports Python CGI scripts. That should be reflected in documentation. ---------- assignee: docs@python components: Documentation messages: 107911 nosy: docs@python, techtonik priority: normal severity: normal status: open title: CGIHTTPServer versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9007> _______________________________________

2 3