Mailman 3 August 2012 - docs

[issue6696] Profile objects should be documented
by Andrew Svetlov 16 Aug '12

16 Aug '12

Changes by Andrew Svetlov <andrew.svetlov(a)gmail.com>: ---------- nosy: +asvetlov _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue6696> _______________________________________

1 0

Re: [docs] Provide some examples for usage of ElementTree methods/attributes (issue 15586)
by ezio.melotti＠gmail.com 15 Aug '12

15 Aug '12

http://bugs.python.org/review/15586/

1 0

Re: [docs] Provide some examples for usage of ElementTree methods/attributes (issue 15586)
by ezio.melotti＠gmail.com 15 Aug '12

15 Aug '12

http://bugs.python.org/review/15586/diff/5727/Doc/library/xml.etree.element… File Doc/library/xml.etree.elementtree.rst (right): http://bugs.python.org/review/15586/diff/5727/Doc/library/xml.etree.element… Doc/library/xml.etree.elementtree.rst:155: ... tree.write('output.xml') This should now have the >>> prompt (same with the following examples). http://bugs.python.org/review/15586/

1 0

[issue15543] central documentation for 'universal newlines'
by Chris Jerdonek 15 Aug '12

15 Aug '12

New submission from Chris Jerdonek: "Universal newlines" of PEP 278 does not seem to have a central, linkable description within the documentation. In particular, there does not seem to be a glossary entry or any index entries for it. The main documentation seems to be in the middle of the documentation for the open() built-in function: http://docs.python.org/dev/library/functions.html?highlight=open#open But this does not feature prominently when searching for universal newlines in the "Quick Search". This would allow us, for example, to reference and link to an explanation of universal newlines in the documentation for str.splitlines(): http://docs.python.org/dev/library/stdtypes.html#str.splitlines I would be happy to provide a patch. ---------- assignee: docs@python components: Documentation keywords: easy messages: 167279 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: central documentation for 'universal newlines' versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15543> _______________________________________

7 26

gzip compression level
by Wolfgang Rohdewald 15 Aug '12

15 Aug '12

http://docs.python.org/library/gzip.html says level is 1..9 actually 0 works too - this the original uncompressed data but with a gzip header. I need level 0 for getting a smaller git repository with many svgz files which have often been edited (the file names and types cannot be changed) So - is this a documentation bug or have I just been lucky? -- Wolfgang

2 1

Bug in part 5 of the Python 3 tutorial
by Anton Eliasson 15 Aug '12

15 Aug '12

Hi! In the Python 3 tutorial about data structures, in the section about nested list comprehensions (http://docs.python.org/py3k/tutorial/datastructures.html#nested-list-compre…); the zip function is described differently than it works in my installation (Ubuntu 12.04). I'm fairly new to Python so the issue is probably described best using an example: $ python3 Python 3.2.3 (default, May 3 2012, 15:51:42) [GCC 4.6.3] on linux2 Type "help", "copyright", "credits" or "license" for more information. >>> matrix = [ ... [1, 2, 3, 4], ... [5, 6, 7, 8], ... [9, 10, 11, 12], ... ] >>> zip(*matrix) <zip object at 0x1053098> However, in the tutorial the zip function returns a list of tuplets like this: >>> zip(*matrix) [(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)] In order to get that result, I have to do this in my installation: >>> list(zip(*matrix)) [(1, 5, 9), (2, 6, 10), (3, 7, 11), (4, 8, 12)] -- Med vänliga hälsningar / Kindest Regards Anton Eliasson

3 2

[issue15656] "Extending Python with C" page needs update for 3.x
by Sandro Tosi 15 Aug '12

15 Aug '12

New submission from Sandro Tosi: Hello, this has been reported at http://mail.python.org/pipermail/docs/2012-July/009223.html but since I have no experience to judge if it's correct or not, i'll just report it: >>> I've recenty started to try using C code in python using the wonderful python API, although i have to say the learning curve was non neglectable :P I've spotted what I believe to be a small mistake in the documentation from this page: http://docs.python.org/release/3.2/extending/extending.html In paragraph 1.8 (http://docs.python.org/release/3.2/extending/extending.html#keyword-paramet…), the code example given contains an error, which is actually obsolete code from python 2.7: void initkeywdarg(void) { /* Create the module and add the functions */ Py_InitModule("keywdarg", keywdarg_methods); } This doesn't work in Python3.2. It's supposed to be static struct PyModuleDef keywdargmodule = { PyModuleDef_HEAD_INIT, "keywdarg", /* name of module */ keywdarg_doc, /* module documentation, may be NULL */ -1, /* size of per-interpreter state of the module, or -1 if the module keeps state in global variables. */ keywdarg_methods }; PyMODINIT_FUNC PyInit_keywdarg(void) { return PyModule_Create(&keywdargmodule); } As explained above (and confirmed by experience). <<< ---------- assignee: docs@python components: Documentation messages: 168223 nosy: docs@python, sandro.tosi priority: normal severity: normal stage: patch review status: open title: "Extending Python with C" page needs update for 3.x versions: Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15656> _______________________________________

4 6

Bug in Functional Programming HOWTO
by Sergey Skovorodkin 15 Aug '12

15 Aug '12

Hi, http://docs.python.org/howto/functional.html#iterators > You’ll run into obvious problems if the iterator is infinite; max(), min(), and "not in" will never return, and if the element X never appears in the stream, the "in" operator won’t return either. "not in" returns False if the element X appears in the stream, so I think it's better to say > max() and min() will never return, and if the element X never appears in the stream, the "in" and "not in" operators won’t return either. -- Sergey Skovorodkin

2 1

[issue15269] Document dircmp.left and dircmp.right
by Chris Jerdonek 14 Aug '12

14 Aug '12

New submission from Chris Jerdonek <chris.jerdonek(a)gmail.com>: The documentation for the filecmp.dircmp class doesn't mention dircmp.left and dircmp.right. Being aware of this up front would make certain simplifications easier to think of. For example, knowing about these attributes opens up the possibility of passing dircmp instances around without having to pass the two paths separately (e.g. in certain recursive algorithms involving dircmp). Knowing this also means you can recover the two paths if using the subdirs attribute (whose values are dircmp instances). ---------- assignee: docs@python components: Documentation keywords: easy messages: 164781 nosy: cjerdonek, docs@python priority: normal severity: normal status: open title: Document dircmp.left and dircmp.right versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15269> _______________________________________

5 17

Error in Python 3 docs for PyMethodDef
by Michael Welsh Duggan 14 Aug '12

14 Aug '12

In the Python 3.2.2 documentation (and earlier Python 3 versions), in the Python/C API Reference Manual, chapter Object Implementation Support, the documentation for PyMethodDef says: The ml_flags field is a bitfield which can include the following flags. The individual flags indicate either a calling convention or a binding convention. Of the calling convention flags, only METH_VARARGS and METH_KEYWORDS can be combined (but note that METH_KEYWORDS alone is equivalent to METH_VARARGS | METH_KEYWORDS). The bit in the parenthetical is incorrect. If you take a look at PyCFunction_Call in Objects/methodobject.c, you will find a switch for METH_VARARGS | METH_KEYWORDS, but no switch for METH_KEYWORDS. Hence, using METH_KEYWORDS will land you with a SystemError that complains about METH_OLDARGS. This is either a bug in the documentation, or a bug in Python. In this case, since the code has persisted through three major revisions of Python 3, I suggest that the bug _is_ in the documentation (whether it should be or not), since changing the code for this at this late date means a programmer has to use METH_VARARGS | METH_KEYWORDS anyway for compatibility. It may be work pointing out specifically in the documentation that just using METH_KEYWORDS will not work. -- Michael Welsh Duggan (mwd(a)cert.org)

2 1