Mailman 3 August 2011 - docs

[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

[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

[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

[issue9014] Incorrect documentation of the PyObject_HEAD macro
by Renato Cunha April 19, 2016

April 19, 2016

New submission from Renato Cunha <renato(a)renatocunha.com>: PyObject_HEAD's documentation in py3k (http://docs.python.org/dev/py3k/c-api/structures.html#PyObject_HEAD) uses the same content used in the python 2.x's docs which is wrong, as there were some API changes. PyObject_HEAD is actually defined as #define PyObject_HEAD PyObject ob_base; with PyObject defined as typedef struct _object { _PyObject_HEAD_EXTRA Py_ssize_t ob_refcnt; struct _typeobject *ob_type; } … [View More]

7 9

[issue10289] Document magic methods called by built-in functions
by Éric Araujo April 10, 2016

April 10, 2016

New submission from Éric Araujo <merwok(a)netwok.org>: At the top of Doc/library/functions.rst, which documents built-in functions like abs, getattr or hash, a comment reads “document all delegations to __special__ methods”. Some functions are already good: enumerate for instance does link to the definition of iterator and hints about the __next__ method, format points to __format__, etc. They can serve as example for how to add links (in plain text and in the global index). ----------… [View More]

10 14

[issue8810] TZ offset description is unclear in docs
by Alexander Belopolsky Feb. 8, 2016

Feb. 8, 2016

New submission from Alexander Belopolsky <belopolsky(a)users.sourceforge.net>: >From <http://docs.python.org/dev/py3k/library/datetime.html#datetime.tzinfo.utcof…>: """ tzinfo.utcoffset(self, dt) Return offset of local time from UTC, in minutes east of UTC. """ This suggests that the return value is an integer representing the number of minutes. It is later explained that in fact "the value returned must be a timedelta object specifying a whole number of minutes", but … [View More]

6 19