Mailman 3 June 2010 - docs

[issue8648] The UTF-7 codec functions are undocumented
by Daniel Stutzbach Dec. 25, 2010

Dec. 25, 2010

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: The UTF-7 codec functions are undocumented: PyUnicode_DecodeUTF7Stateful PyUnicode_DecodeUTF7 PyUnicode_EncodeUTF7 ---------- assignee: docs@python components: Documentation messages: 105207 nosy: docs@python, stutzbach priority: normal severity: normal stage: needs patch status: open title: The UTF-7 codec functions are undocumented versions: Python 2.6, Python 3.1 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8648> _______________________________________

4 4

[issue9063] TZ examples in datetime.rst are incorrect
by Alexander Belopolsky Dec. 23, 2010

Dec. 23, 2010

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: With python started at the root of the source tree and TZ=US/Eastern in the environment, >>> exec(open('Doc/includes/tzinfo-examples.py').read()) >>> import os >>> os.environ['TZ'] 'US/Eastern' >>> from datetime import * >>> x = datetime(2010, 11, 7, 5, tzinfo=timezone.utc) >>> print(x, x.astimezone(Local), x.astimezone(Eastern)) 2010-11-07 05:00:00+00:00 2010-11-07 01:00:00-04:00 2010-11-07 01:00:00-05:00 >>> x.astimezone(Local).dst() == x.astimezone(Eastern).dst() False Note that according to my understanding of the long comment at the end of datetimemodule.c, zone conversion from UTC is a well defined operation unless there is a bug in tzinfo subclass implementation. ---------- assignee: docs@python components: Documentation messages: 108462 nosy: belopolsky, docs@python priority: normal severity: normal stage: needs patch status: open title: TZ examples in datetime.rst are incorrect versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9063> _______________________________________

2 5

[issue8851] pkgutil document needs more markups
by MATSUI Tetsushi Dec. 15, 2010

Dec. 15, 2010

New submission from MATSUI Tetsushi <mft(a)users.sourceforge.net>: The library reference of pkgutil is only sparsely marked up. The attached patch is against 2.6 version, because I'm currently working with 2.6. Since a part of markups (namely :pep:'s) has already been done for 3.2 version, the patch cannot be applied directly to that version, and I haven't checked the versions in between. ---------- assignee: docs@python components: Documentation files: pkgutil.diff keywords: patch messages: 106708 nosy: docs@python, mft priority: normal severity: normal status: open title: pkgutil document needs more markups versions: Python 2.6 Added file: http://bugs.python.org/file17492/pkgutil.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8851> _______________________________________

2 3

[issue8647] PyUnicode_GetMax is undocumented
by Daniel Stutzbach Nov. 20, 2010

Nov. 20, 2010

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: Here's the relevant signature: /* Get the maximum ordinal for a Unicode character. */ PyAPI_FUNC(Py_UNICODE) PyUnicode_GetMax(void); ---------- assignee: docs@python components: Documentation messages: 105206 nosy: docs@python, stutzbach priority: normal severity: normal stage: needs patch status: open title: PyUnicode_GetMax is undocumented versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8647> _______________________________________

5 6

[issue8645] PyUnicode_AsEncodedObject is undocumented
by Daniel Stutzbach Nov. 20, 2010

Nov. 20, 2010

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: PyUnicode_AsEncodedObject is undocumented. It has the same signature as PyUnicode_AsEncodedString, although they do slightly different things based on a brief source code inspection (I'm not clear on what that difference is though). ---------- assignee: docs@python components: Documentation messages: 105203 nosy: docs@python, stutzbach priority: normal severity: normal stage: needs patch status: open title: PyUnicode_AsEncodedObject is undocumented versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8645> _______________________________________

4 5

[issue8649] Py_UNICODE_* functions are undocumented
by Daniel Stutzbach Nov. 16, 2010

Nov. 16, 2010

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: Python provides several functions for manipulating raw Py_UNICODE strings, but they aren't documented. Below are their signatures. PyAPI_FUNC(size_t) Py_UNICODE_strlen(const Py_UNICODE *u); PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strcpy( Py_UNICODE *s1, const Py_UNICODE *s2); PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strncpy( Py_UNICODE *s1, const Py_UNICODE *s2, size_t n); PyAPI_FUNC(int) Py_UNICODE_strcmp( const Py_UNICODE *s1, const Py_UNICODE *s2); PyAPI_FUNC(Py_UNICODE*) Py_UNICODE_strchr( const Py_UNICODE *s, Py_UNICODE c ); ---------- assignee: docs@python components: Documentation messages: 105214 nosy: docs@python, stutzbach priority: normal severity: normal stage: needs patch status: open title: Py_UNICODE_* functions are undocumented versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8649> _______________________________________

5 5

[issue9117] class syntax not fully documented in reference manual
by Mark Dickinson Oct. 17, 2010

Oct. 17, 2010

New submission from Mark Dickinson <dickinsm(a)gmail.com>: Looking at: http://docs.python.org/dev/py3k/reference/compound_stmts.html#class-definit… I see: classdef ::= [decorators] "class" classname [inheritance] ":" suite inheritance ::= "(" [expression_list] ")" classname ::= identifier this seems to be missing the keyword arguments that are now possible in a classdef (e.g. for specifying a metaclass). I believe that *args and **kwargs are now also syntactically accepted in a class definition. ---------- assignee: docs@python components: Documentation messages: 108917 nosy: docs@python, mark.dickinson priority: normal severity: normal status: open title: class syntax not fully documented in reference manual versions: Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9117> _______________________________________

3 9

[issue9112] argparse missing documentation for error() method
by Mark Summerfield Oct. 17, 2010

Oct. 17, 2010

New submission from Mark Summerfield <mark(a)qtrac.eu>: The argparse module's ArgumentParser class has an error() method that appears to have the same behavior as the optparse error() method, but this method is not mentioned in the documentation. ---------- assignee: docs@python components: Documentation messages: 108896 nosy: docs@python, mark priority: normal severity: normal status: open title: argparse missing documentation for error() method versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9112> _______________________________________

4 3

[issue9105] pickle security note should be more prominent
by anatoly techtonik Oct. 17, 2010

Oct. 17, 2010

New submission from anatoly techtonik <techtonik(a)gmail.com>: Pickle warning about insecurity is located only at the second page near the bottom of "Relationship to other Python modules" chapter. For me the proper place for it is the first page of documentation. ---------- assignee: docs@python components: Documentation messages: 108847 nosy: docs@python, techtonik priority: normal severity: normal status: open title: pickle security note should be more prominent versions: Python 2.6, Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9105> _______________________________________

5 9

parser library documentation references non-existent example.py
by Bill Zingler Oct. 17, 2010

Oct. 17, 2010

Reference: http://docs.python.org/library/parser.html#information-discovery <http://docs.python.org/library/parser.html>This page says to "See file example.py" several times, but doesn't provide a link to the file or the complete text of the file. It would be really helpful to have example.py. Thanks, Bill -- Bill Zingler Zingler & Associates, Inc. (443) 822-4857

2 1