Mailman 3 October 2011 - docs

[issue11924] Pickle and copyreg modules doesn't document the interface
by Jesús Cea Avión Feb. 18, 2017

Feb. 18, 2017

New submission from Jesús Cea Avión <jcea(a)jcea.es>: Python 3.2 here. "copyreg" module documentation says "See the pickle module for more details on the interface expected of function and constructor.", but I don't see any useful "copyreg" reference in pickle documentation. Some examples would be useful here, too. ---------- assignee: docs@python messages: 134416 nosy: docs@python, jcea priority: normal severity: normal status: open title: Pickle and copyreg modules doesn't document … [View More]

5 6

[issue11173] Undocumented public APIs in Python 3.2
by Marc-Andre Lemburg Feb. 14, 2017

Feb. 14, 2017

New submission from Marc-Andre Lemburg <mal(a)egenix.com>: Mark Shannon on python-dev: The following API functions were removed from 3.1.3: PyAST_Compile PyCObject_AsVoidPtr PyCObject_FromVoidPtr PyCObject_FromVoidPtrAndDesc PyCObject_GetDesc PyCObject_Import PyCObject_SetVoidPtr PyCode_CheckLineNumber Py_CompileStringFlags PyEval_CallObject PyOS_ascii_atof PyOS_ascii_formatd PyOS_ascii_strtod PyThread_exit_prog PyThread__PyThread_exit_prog PyThread__PyThread_exit_thread … [View More]

5 7

[issue11726] linecache becomes specific to Python scripts in Python 3
by STINNER Victor Feb. 9, 2017

Feb. 9, 2017

New submission from STINNER Victor <victor.stinner(a)haypocalc.com>: linecache document doesn't tell that the module reads the #coding:xxx cookie to get the encoding of the Python file. linecache reads this cookie since 41665 (May 09 2007). "The linecache module allows one to get any line from any file, ..." => "any file"! And the example uses /etc/passwd which is not a Python file. Not only it reads the #coding:xxx cookie, but updatecache() tries also a PEP 302 loader to read the … [View More]

8 16

[issue13196] subprocess: undocumented if shell=True is necessary to find executable in Windows PATH
by anatoly techtonik Feb. 4, 2017

Feb. 4, 2017

New submission from anatoly techtonik <techtonik(a)gmail.com>: The reason I ask is this changeset - http://code.google.com/p/spyderlib/source/detail?spec=svne5d86b685619a470d5… - seems like without shell=True, subprocess.Popen is unable to find Mercurial executable in PATH. ---------- assignee: docs@python components: Documentation messages: 145664 nosy: docs@python, techtonik priority: normal severity: normal status: open title: subprocess: undocumented if shell=True is necessary to … [View More]

5 6

[issue11670] configparser read_file now iterates over f, docs still say it calls readline
by Larry Hastings Jan. 29, 2017

Jan. 29, 2017

New submission from Larry Hastings <larry(a)hastings.org>: The documentation for configparser.RawConfigParser.read_file() states: "Read and parse configuration data from the file or file-like object in f (only the readline() method is used)." This was true in Python 3.1 and before. However in 3.2 the implementation of read_file changed. It no longer calls readline(). Instead, it iterates over the file object. Whoever made this change neglected to * fix the docs, or apparently * … [View More]

5 9

[issue10415] readline.insert_text documentation incomplete
by Justin Lebar Oct. 1, 2016

Oct. 1, 2016

New submission from Justin Lebar <justin.lebar(a)gmail.com>: The readline documentation currently says: > readline.insert_text(string) > Insert text into the command line. But as far as I can tell, readline.insert_text() does something only when called from startup_hook or pre_input_hook. Here's an example of someone using the module in a way that works: http://swapoff.org/svn/cly/tags/0.7/cly/interactive.py ---------- assignee: docs@python components: Documentation … [View More]

6 7

[issue12946] PyModule_GetDict() claims it can never fail, but it can
by Stefan Behnel Aug. 19, 2016

Aug. 19, 2016

New submission from Stefan Behnel <scoder(a)users.sourceforge.net>: As is obvious from the code, PyModule_GetDict() can fail if being passed a non-module object, and when the (unlikely) dict creation at the end fails. The documentation of the C-API function should be fixed to reflect that, i.e. it should state that NULL is returned in the case of an error. PyObject * PyModule_GetDict(PyObject *m) { PyObject *d; if (!PyModule_Check(m)) { PyErr_BadInternalCall(); … [View More]

7 11

[issue12243] getpass.getuser works on OSX
by Bryce Verdier June 2, 2016

June 2, 2016

New submission from Bryce Verdier <bryceverdier(a)gmail.com>: In the docs for getpass: http://docs.python.org/release/2.6.6/library/getpass.html (as an example). It hints that getuser() doesn't work on OSX. I tried this out and it works fine for python 2.6 on 10.6. I have included a patch for this. I believe the cleanest way to handle this is to remove the "Availability" entry as it's no longer necessary. ---------- assignee: docs@python components: Documentation files: getuser.patch … [View More]

7 12

[issue9911] doc copyedits
by DSM May 26, 2016

May 26, 2016

New submission from DSM <dsm001(a)users.sourceforge.net>: Various typo fixes for the docs. As usual, I left historical documents alone (except for 3.1 whatsnew: fixed the spelling of Jack Diederich's name). Fixing ~30 means I probably introduced ~3 problems of my own, but that should still be a net win.. Patch against py3k r84944. ---------- assignee: docs@python components: Documentation files: typos.patch keywords: patch messages: 117052 nosy: docs@python, dsm001 priority: normal … [View More]

3 2

[issue11643] Use |version| instead of X.Y in the doc
by Éric Araujo May 7, 2016

May 7, 2016

New submission from Éric Araujo <merwok(a)netwok.org>: Some files like site.rst use “X.Y” to refer to the Python version, but Sphinx helpfully provides a |version| construct that can be replaced by the current version at build time. ---------- assignee: docs@python components: Documentation keywords: easy messages: 131816 nosy: docs@python, eric.araujo priority: normal severity: normal stage: needs patch status: open title: Use |version| instead of X.Y in the doc versions: Python 2.7, … [View More]

8 15