Mailman 3 September 2010 - docs

[issue9063] TZ examples in datetime.rst are incorrect
by Alexander Belopolsky 24 Dec '10

24 Dec '10

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 16 Dec '10

16 Dec '10

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

[issue9746] All sequence types support .index and .count
by Daniel Stutzbach 21 Nov '10

21 Nov '10

New submission from Daniel Stutzbach <daniel(a)stutzbachenterprises.com>: In the list of operations supported by all sequence types, the .index and .count methods should be included. They are defined by the collections.Sequence ABC that all sequences support. (except for range objects, but that will be fixed in Issue9213) ---------- assignee: docs@python components: Documentation messages: 115397 nosy: docs@python, stutzbach priority: normal severity: normal stage: needs patch status: open title: All sequence types support .index and .count type: behavior versions: Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9746> _______________________________________

6 8

[issue8647] PyUnicode_GetMax is undocumented
by Daniel Stutzbach 21 Nov '10

21 Nov '10

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 21 Nov '10

21 Nov '10

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 16 Nov '10

16 Nov '10

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

[issue9886] Make operator.itemgetter/attrgetter/methodcaller easier to discover
by Nick Coghlan 01 Nov '10

01 Nov '10

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: The observation has been made that there are some idioms related to key functions passed to various methods and functions that aren't particularly easy to discover. One suggestion is to create a "key function" glossary entry that provides examples of standard library operations that exist primarily for use as key functions (i.e. the three functions mentioned in the issue title), as well as mentioning some of the APIs that accept key functions (e.g. sorted, list.sort, min, max). The documentation of these various could then cross link to the "key function" glossary entry to make this idioms more discoverable without needing to repeat ourselves in the documentation of every method that accepts a key function. As per discussion on python-ideas, including the glossary entry suggestion from Terry Reedy: http://mail.python.org/pipermail/python-ideas/2010-September/008093.html ---------- assignee: docs@python components: Documentation messages: 116658 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Make operator.itemgetter/attrgetter/methodcaller easier to discover versions: Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9886> _______________________________________

3 3

[issue9730] base64 encoding takes in bytes rather than string.
by JingCheng LIU 18 Oct '10

18 Oct '10

New submission from JingCheng LIU <liuexp(a)gmail.com>: http://docs.python.org/py3k/library/base64.html?highlight=base64 the examples given doesn't work ---------- assignee: docs@python components: Documentation messages: 115287 nosy: Dmitry.Jemerov, JingCheng.LIU, docs@python, ezio.melotti, orsenthil, pitrou priority: normal severity: normal status: open title: base64 encoding takes in bytes rather than string. type: behavior versions: Python 3.1 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9730> _______________________________________

8 18

Documentation for ebook
by Andrés Orencio Ramírez Pérez 17 Oct '10

17 Oct '10

Is possible get documentation in ebook format (epub for example) o A5 size? It would be fatastic to have a link for download from documentation web page. Regards.

2 1

little mistake in documentation of dis.opmap in the dis module
by Alexander Behringer 17 Oct '10

17 Oct '10

Hello, I think I have discovered a little mistake in the documentation of the disassembler module. There it says [1, 2, 3]: > dis.opmap > Dictionary mapping bytecodes to operation names. But for me it looks more like a mapping of operation names to bytecodes. [1] http://docs.python.org/library/dis.html#dis.opmap [2] http://docs.python.org/py3k/library/dis.html#dis.opmap [3] http://docs.python.org/dev/py3k/library/dis.html#dis.opmap Sincerely, Alexander

2 1