Mailman 3 November 2015 - docs

[issue18353] PyUnicode_WRITE_CHAR macro definition missing
by Wolf Ihlenfeldt 23 Apr '16

23 Apr '16

New submission from Wolf Ihlenfeldt: Above macro is mentioned in the documentation (3.3.2), but does not appear in the header files. Associated function PyUnicode_WriteChar() is present and works as expected. ---------- assignee: docs@python components: Documentation, Unicode messages: 192247 nosy: Wolf.Ihlenfeldt, docs@python, ezio.melotti priority: normal severity: normal status: open title: PyUnicode_WRITE_CHAR macro definition missing type: compile error versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18353> _______________________________________

6 5

[issue21382] Signal module doesnt raises ValueError Exception
by rsevcan 23 Apr '16

23 Apr '16

New submission from rsevcan: signal.signal() built-in function doesnt throws a ValueError exception in Windows when is called with a different signal than SIGABRT, SIGFPE, SIGILL, SIGINT, SIGSEGV, or SIGTERM, as it is written in the documentation. https://docs.python.org/2/library/signal.html#signal.signal https://docs.python.org/3/library/signal.html#signal.signal It throws an AttributeError Exception >>> import signal >>> import sys >>> sys.platform 'win32' >>> signal.signal(signal.SIGPIPE, lambda signum, frame: sys.exit(1)) Traceback (most recent call last): File "<stdin>", line 1, in <module> AttributeError: 'module' object has no attribute 'SIGPIPE' >>> Regards ---------- assignee: docs@python components: Documentation messages: 217486 nosy: docs@python, rsevcan priority: normal severity: normal status: open title: Signal module doesnt raises ValueError Exception type: enhancement versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21382> _______________________________________

5 5

[issue20112] The documentation for http.server error_message_format is inadequate.
by R. David Murray 23 Apr '16

23 Apr '16

New submission from R. David Murray: The description of error_message_format does not give enough information to use it. The description should talk about how it is used (ie: using % formatting) and the fact that when filled in it should form a complete html document because it will be sent as the error response body. It should not talk about what "the code key should be", etc, but should instead say what they *will* be, and cross reference the send_error method as the thing that uses it. ---------- assignee: docs@python components: Documentation messages: 207194 nosy: docs@python, r.david.murray priority: normal severity: normal stage: needs patch status: open title: The documentation for http.server error_message_format is inadequate. type: behavior versions: Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20112> _______________________________________

5 23

[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 18 Apr '16

18 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

[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

[issue25314] Documentation: argparse's actions store_{true, false} default to False/True (undocumented)
by Julien Baley 15 Apr '16

15 Apr '16

New submission from Julien Baley: The documentation of the action `store_const` states that it defaults to None. In turn, the documentation of `store_true` and `store_false` states that "[t]hese are special cases of 'store_const'", suggesting that they would also default to None. Thankfully, `store_true` defaults to False and `store_false` to True, but this is not documented. That would be useful, as I keep seeing people writing `action='store_true' default=False` and vice-versa. ---------- assignee: docs@python components: Documentation files: store_true_false_doc.patch keywords: patch messages: 252288 nosy: Julien Baley, docs@python priority: normal severity: normal status: open title: Documentation: argparse's actions store_{true,false} default to False/True (undocumented) type: enhancement Added file: http://bugs.python.org/file40676/store_true_false_doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25314> _______________________________________

6 17

[issue15984] Wrong documentation for PyUnicode_FromObject()
by Serhiy Storchaka 14 Apr '16

14 Apr '16

New submission from Serhiy Storchaka: In the documentation it is written that PyUnicode_FromObject() is a shortcut for PyUnicode_FromEncodedObject(). But PyUnicode_FromObject() is not call PyUnicode_FromEncodedObject() direct nor indirect. PyUnicode_FromObject() works only with unicode and unicode subclass objects, PyUnicode_FromEncodedObject() is not works with unicode objects. ---------- assignee: docs@python components: Documentation messages: 170821 nosy: docs@python, storchaka priority: normal severity: normal status: open title: Wrong documentation for PyUnicode_FromObject() versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15984> _______________________________________

11 26

[issue14456] Relation between threads and signals unclear
by Sven Marnach 10 Apr '16

10 Apr '16

New submission from Sven Marnach <sven(a)marnach.net>: The documentation of the 'signal' module states on the one hand [T]he main thread will be the only one to receive signals (this is enforced by the Python signal module, even if the underlying thread implementation supports sending signals to individual threads). On the other hand, it provides the function 'pthread_kill()': Send the signal signum to the thread thread_id, another thread in the same process as the caller. The signal is asynchronously directed to thread. These two passages are in contradiction to each other. The documentation also states that only the main thread can set signal handlers -- if this is true, it is utterly unclear how sending signals to other threads is useful. Probably the documentation wasn't fully updated when the above function was introduced. ---------- assignee: docs@python components: Documentation messages: 157156 nosy: docs@python, smarnach priority: normal severity: normal status: open title: Relation between threads and signals unclear versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14456> _______________________________________

4 6

[issue10289] Document magic methods called by built-in functions
by Éric Araujo 09 Apr '16

09 Apr '16

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). ---------- assignee: docs@python components: Documentation messages: 120189 nosy: docs@python, eric.araujo priority: normal severity: normal stage: needs patch status: open title: Document magic methods called by built-in functions versions: Python 2.7, Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue10289> _______________________________________

10 14