Mailman 3 October 2010 - docs

[issue9370] Add reader redirect from test package docs to unittest module
by Nick Coghlan 31 Dec '10

31 Dec '10

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: Brett updated the docs for the test package to (correctly) point out that it is our internal testing package and isn't subject to the same stringent backwards compatibility rules as the rest of the standard library. A "see also" link pointing readers that have landed there over to the unittest module for their testing infrastructure needs would be a friendly thing to include. ---------- assignee: docs@python components: Documentation keywords: easy messages: 111450 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Add reader redirect from test package docs to unittest module versions: Python 2.7, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9370> _______________________________________

3 3

[issue9891] Minor doc typo at datamodel.rst: "list" -> "alist"
by Rodrigo Bernardo Pimentel 25 Dec '10

25 Dec '10

New submission from Rodrigo Bernardo Pimentel <rbp(a)isnomore.net>: The "Built-in methods" item of the "The standard type hierarchy" section of Doc/reference/datamodels.rst uses a list instance called "alist" as an example, and it says "__self__ is set to the object denoted by *list*." It should read "the object denoted by *alist*" This affects all releases, so I've marked them all. But I suppose we don't care about 2.5 anymore. All the others are listed on docs.python.org (or are "trunk"), and I think should be fixed. It's a trivial fix, and a single patch works 2.x and another for 3.x. ---------- assignee: docs@python components: Documentation files: alist_doc-2.x.patch keywords: patch messages: 116757 nosy: docs@python, rbp priority: normal severity: normal status: open title: Minor doc typo at datamodel.rst: "list" -> "alist" versions: Python 2.5, Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3 Added file: http://bugs.python.org/file18914/alist_doc-2.x.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9891> _______________________________________

2 3

[issue8648] The UTF-7 codec functions are undocumented
by Daniel Stutzbach 25 Dec '10

25 Dec '10

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

23 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 15 Dec '10

15 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

[issue10172] code block has no syntax coloring
by Winston C. Yang 26 Nov '10

26 Nov '10

New submission from Winston C. Yang <winston(a)cs.wisc.edu>: The following code block in http://docs.python.org/tutorial/errors.html has no syntax coloring: import sys try: f = open('myfile.txt') s = f.readline() i = int(s.strip()) except IOError as (errno, strerror): print "I/O error({0}): {1}".format(errno, strerror) except ValueError: print "Could not convert data to an integer." except: print "Unexpected error:", sys.exc_info()[0] raise ---------- assignee: docs@python components: Documentation messages: 119382 nosy: docs@python, wcyang priority: normal severity: normal status: open title: code block has no syntax coloring type: behavior versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10172> _______________________________________

3 2

Standard Library, Brief Tour, os.system() example, small nit
by Robert Terzi 26 Nov '10

26 Nov '10

http://docs.python.org/tutorial/stdlib.html In section 10.1, Operating System Interface, I have a small nit with the first example for os.system. First it doesn't mention what os.system does, Second the example command is DOS/Windows specific, Third, if run it will change the current time on your DOS/Windows machine. I think that example could easily by improved. My suggestions for a command that I think will work under Windows, *nix, and OS X, are either 'mkdir' or 'set' to get a list of environment variables. Currently the example text is: >>> import os >>> os.system('time 0:02') 0 >>> os.getcwd() # Return the current working directory 'C:\\Python26' >>> os.chdir('/server/accesslogs') My suggestion is: >>> import os >>> os.getcwd() # Return the current working directory 'C:\\Python26' >>> os.chdir('/server/accesslogs') # Change current working directory >>> os.system('mkdir today') # Run the command mkdir in the system shell 0 Alternate >>> os.system('set') # Run the command set in the system shell <displays a list of environment variables> Thanks, --Rob

2 1

[issue10122] Documentation typo fix and a side question
by Retro 26 Nov '10

26 Nov '10

New submission from Retro <vinetouu(a)gmail.com>: Please read the first sentence of the docs for the built-in function getattr() here: http://docs.python.org/library/functions.html?highlight=getattr#getattr Fix the word 'attributed' to 'attribute', because the former is a typo. A side question. When you document an object's API in the docstring, you write it like this: getattr(object, name[, default]) -> value Don't you find it nicer if that would look like this: getattr(object, name, [default]) -> value Note the cosmetic fix between the arguments 'name' and 'default'. Do you find my fix acceptable? If yes, please fix docstrings in Python that document the object's API from the '...name[, default]...' format to '...name, [default]...' format. ---------- assignee: docs@python components: Documentation messages: 118869 nosy: Retro, docs@python priority: normal severity: normal status: open title: Documentation typo fix and a side question versions: 3rd party, Python 2.5, 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/issue10122> _______________________________________

5 7

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

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

20 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