Mailman 3 November 2015 - docs

[issue23710] C API doc for PyObject_HEAD is outdated
by Tomi Pieviläinen 03 Aug '16

03 Aug '16

New submission from Tomi Pieviläinen: https://docs.python.org/3/c-api/structures.html#c.PyObject_HEAD says that the macro should be used for creating new types and that it has ob_type. Unfortunately at some point (@61466 perhaps) that definition in object.h was changed. This affects other pages too (at least https://docs.python.org/3/extending/newtypes.html). I encountered this while checking if a C extension (imposm.parser) could be trivially ported for Python 3. Unfortunately not. I suppose self->ob_type should be replaced with Py_TYPE(self) but that isn't really clear from the docs. ---------- assignee: docs@python components: Documentation messages: 238530 nosy: docs@python, tpievila priority: normal severity: normal status: open title: C API doc for PyObject_HEAD is outdated _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23710> _______________________________________

7 10

[issue23943] Misspellings in a few files
by Piotr Kasprzyk 28 Jul '16

28 Jul '16

New submission from Piotr Kasprzyk: Correct misspellings in various files. ---------- assignee: docs@python components: Documentation files: misspellings.patch keywords: patch messages: 240825 nosy: docs@python, kwadrat priority: normal severity: normal status: open title: Misspellings in a few files type: enhancement versions: Python 3.5 Added file: http://bugs.python.org/file38977/misspellings.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23943> _______________________________________

3 4

[issue19198] Improve cross-references in cgi documentation
by Serhiy Storchaka 25 Jul '16

25 Jul '16

New submission from Serhiy Storchaka: Here is a patch which fixes internal references in the documentation of the cgi module. ---------- assignee: docs@python components: Documentation files: refs.cgi.patch keywords: patch messages: 199249 nosy: docs@python, serhiy.storchaka priority: normal severity: normal stage: patch review status: open title: Improve cross-references in cgi documentation type: enhancement versions: Python 2.7, Python 3.3, Python 3.4 Added file: http://bugs.python.org/file32006/refs.cgi.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue19198> _______________________________________

2 3

[issue25393] 'resource' module documentation error
by Χρήστος Γεωργίου (Christos Geo rgiou) 19 Jul '16

19 Jul '16

New submission from Χρήστος Γεωργίου (Christos Georgiou): https://docs.python.org/3.5/library/resource.html https://docs.python.org/3.5/library/resource.html#resource.RLIMIT_FSIZE ends with the sentence "This only affects the stack of the main thread in a multi-threaded process." I believe this sentence should be appended to https://docs.python.org/3.5/library/resource.html#resource.RLIMIT_STACK This error also exists in previous versions of python documentation. ---------- assignee: docs@python components: Documentation messages: 252935 nosy: docs@python, tzot priority: normal severity: normal status: open title: 'resource' module documentation error type: enhancement versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25393> _______________________________________

6 5

Python documentation : some points requiring attention
by Jacques 13 Jul '16

13 Jul '16

Hello, First, I want to thank you for the useful and clear documentation of Python. Beeing a fanatic reader of it, sometimes I encounter some mistake (or it seems to me it is such). If this could bring some help, you will find in the attached file a list of points requiring attention. All the comments concern the official standard documentation of Python 3.4.0. With regards. Jacques Ducasse FRANCE

3 4

[issue13402] Document absoluteness of sys.executable
by Éric Araujo 12 Jul '16

12 Jul '16

New submission from Éric Araujo <merwok(a)netwok.org>: I wanted to know if sys.executable was always an absolute path but the doc does not talk about that. (My use case is that I’d like to reload a process and I wonder if I can call os.execve or if I need to use os.execvpe.) ---------- assignee: docs@python components: Documentation messages: 147609 nosy: docs@python, eric.araujo priority: normal severity: normal status: open title: Document absoluteness of sys.executable versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13402> _______________________________________

11 21

[issue25523] Correct "a" article to "an" article
by Martin Panter 11 Jul '16

11 Jul '16

New submission from Martin Panter: This patch generally changes “a” to “an” where appropriate in the main documentation, doc strings, source code comments, and a couple error messages in the test suite. Since it touches so many files, I thought it would be good to get a quick review. ---------- assignee: docs@python components: Documentation files: a-an.patch keywords: patch messages: 253784 nosy: docs@python, martin.panter priority: normal severity: normal stage: patch review status: open title: Correct "a" article to "an" article versions: Python 3.4, Python 3.5, Python 3.6 Added file: http://bugs.python.org/file40909/a-an.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25523> _______________________________________

6 18

[issue24314] irrelevant cross-link in documentation of user-defined functions
by July Tikhonov 18 Jun '16

18 Jun '16

New submission from July Tikhonov: https://docs.python.org/3/reference/datamodel.html#the-standard-type-hierar… There is a table of "special attributes" of user-defined functions. The __name__ attribute name is a link, but it leads to something quite irrelevant: the description of __name__ attribute of imported modules. In Doc/reference/datamodel.rst, there is nothing special about __name__ attribute, so it looks like some random spasm of Sphinx creating links here and there. My knowledge of rst is not sufficient to suppress it. ---------- assignee: docs@python components: Documentation messages: 244301 nosy: docs@python, july priority: normal severity: normal status: open title: irrelevant cross-link in documentation of user-defined functions type: behavior versions: Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24314> _______________________________________

3 3

[issue23360] Content-Type when sending data with urlopen()
by Martin Panter 17 Jun '16

17 Jun '16

New submission from Martin Panter: Currently the documentation gives the impression that the “data” parameter to Request() has to be in the application/x-www-form-urlencoded format. However I suspect that you can override the type by supplying a Content-Type header, and I would like to document this; see uploaded patch. I noticed that test_urllib2.HandlerTests.test_http() already seems to test the default Content-Type and a custom Content-Type with a Request() object, although I did not see a test for the default Content-Type when supplying “data” directly to urlopen(). Also I understand the “charset” parameter on application/x-www-form-urlencoded is not standardized. Would it correspond to the encoding of the %XX codes from urlencode(), which is typically UTF-8, not Latin-1? Or would it correspond to the subsequent string-to-bytes encoding stage, which could just be ASCII since non-ASCII characters are already encoded? Maybe it would be best to drop the advice to set a “charset” parameter. It was added for Issue 11082. ---------- assignee: docs@python components: Documentation files: non-urlencoded.patch keywords: patch messages: 235166 nosy: docs@python, vadmium priority: normal severity: normal status: open title: Content-Type when sending data with urlopen() versions: Python 3.4 Added file: http://bugs.python.org/file37959/non-urlencoded.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23360> _______________________________________

3 9

[issue22558] Missing hint to source code - complete
by Friedrich Spee von Langenfeld 13 Jun '16

13 Jun '16

12 39