Mailman 3 April 2016 - docs

[issue9014] Incorrect documentation of the PyObject_HEAD macro
by Renato Cunha 19 Apr '16

19 Apr '16

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; } PyObject; (The PyTRACE_REFS discussion is still valid, though.) Additionally, it'd be nice to mention that the Py_REFCNT(ob) and Py_TYPE(ob) macros should be used to access the PyObject members. ---------- assignee: docs@python components: Documentation messages: 107953 nosy: docs@python, trovao priority: normal severity: normal status: open title: Incorrect documentation of the PyObject_HEAD macro type: behavior versions: Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9014> _______________________________________

7 9

[issue23251] mention in time.sleep() docs that it does not block other Python threads
by Akira Li 19 Apr '16

19 Apr '16

New submission from Akira Li: There is the corresponding StackOverflow question with 60K view "time.sleep — sleeps thread or process?" [1] The documentation patch is attached. [1] http://stackoverflow.com/questions/92928/time-sleep-sleeps-thread-or-process ---------- assignee: docs@python components: Documentation files: docs-time.sleep-other-threads-are-not-blocked.diff keywords: patch messages: 234135 nosy: akira, docs@python priority: normal severity: normal status: open title: mention in time.sleep() docs that it does not block other Python threads type: enhancement versions: Python 3.5 Added file: http://bugs.python.org/file37730/docs-time.sleep-other-threads-are-not-bloc… _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23251> _______________________________________

9 19

[issue26615] Missing entry in WRAPPER_ASSIGNMENTS in update_wrapper's doc
by Xiang Zhang 18 Apr '16

18 Apr '16

New submission from Xiang Zhang: WRAPPER_ASSIGNMENTS now contains __qualname__ but the documentation doesn't mention it. ---------- assignee: docs@python components: Documentation files: functools_doc.patch keywords: patch messages: 262237 nosy: docs@python, xiang.zhang priority: normal severity: normal status: open title: Missing entry in WRAPPER_ASSIGNMENTS in update_wrapper's doc versions: Python 3.6 Added file: http://bugs.python.org/file42247/functools_doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26615> _______________________________________

3 2

[issue26795] Fix PEP 344 Python version
by Marat Sharafutdinov 18 Apr '16

18 Apr '16

New submission from Marat Sharafutdinov: Should be 3.0 instead of 2.5 ---------- assignee: docs@python components: Documentation files: pep-0344-version.patch keywords: patch messages: 263667 nosy: decaz, docs@python priority: normal severity: normal status: open title: Fix PEP 344 Python version type: enhancement Added file: http://bugs.python.org/file42505/pep-0344-version.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26795> _______________________________________

2 1

[issue25987] collections.abc.Reversible
by Roundup Robot 18 Apr '16

18 Apr '16

Roundup Robot added the comment: New changeset 7d9f7d7a21ae by Georg Brandl in branch 'default': #25987: add versionadded to Reversible. https://hg.python.org/cpython/rev/7d9f7d7a21ae ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25987> _______________________________________

1 0

[issue25987] collections.abc.Reversible
by Guido van Rossum 18 Apr '16

18 Apr '16

Guido van Rossum added the comment: Because it's a change to collections.abc, it goes in 3.6 only. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25987> _______________________________________

1 0

Doc Bug
by Emilie Menard Barnard 18 Apr '16

18 Apr '16

Hi there, I found a small typo in the documentation for 3.5 under turtle’s circle function explanation. It reads: "Draw a circle with given radius. The center is radius units left of the turtle” but it should read "Draw a circle with given radius. The center is radius units above the turtle” Thanks, Emilie

1 0

[issue25987] collections.abc.Reversible
by Ivan Levkivskyi 17 Apr '16

17 Apr '16

Ivan Levkivskyi added the comment: I see that I forgot to include .. versionadded:: in the documentation. Will this go into 3.5.2 or in 3.6? ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25987> _______________________________________

1 0

[issue24173] curses HOWTO/implementation disagreement
by White_Rabbit 16 Apr '16

16 Apr '16

New submission from White_Rabbit: Similarly to issue 6771¹, the curses HOWTO² talks about the curses.wrapper module and its curses.wrapper.wrapper function, but with python 2.7.5-ubuntu3 I already have the curses.wrapper function. ¹ https://bugs.python.org/issue6771 ² https://docs.python.org/2/howto/curses.html ---------- assignee: docs@python components: Documentation messages: 243058 nosy: White_Rabbit, docs@python priority: normal severity: normal status: open title: curses HOWTO/implementation disagreement versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24173> _______________________________________

3 2

[issue25989] documentation version switcher is broken fro 2.6, 3.2, 3.3
by Vincent Davis 16 Apr '16

16 Apr '16

New submission from Vincent Davis: >From the documentation pages for python 2.7 and 3.4, 3.5, 3.6 it is possible to select another python version in the breadcrumb at the top left of the page. This is not available for python 2.6, 3.2 and 3.3. See related issue which is closed. https://bugs.python.org/issue25113 I posted this on pythondotorg but I guess this is a cpython issue not a website issue. https://github.com/python/pythondotorg/issues/868 Berker Peksag response to the report "The version switcher is activated via a versionswitcher option in Doc/Makefile in CPython codebase. Docs are generated daily by using that Makefile, but 2.6, 3.2 and 3.3 are in security-fix-only mode (which means they won't even get documentation fixes) so the daily build script skips generating docs for those versions." ---------- assignee: docs@python components: Documentation messages: 257317 nosy: Vincentdavis, docs@python priority: normal severity: normal status: open title: documentation version switcher is broken fro 2.6, 3.2, 3.3 type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25989> _______________________________________

2 1