Mailman 3 June 2018 - docs

[issue18925] select.poll.modify is not documented
by Giampaolo Rodola' Aug. 19, 2018

Aug. 19, 2018

New submission from Giampaolo Rodola': It was introduced in Python 2.6: http://bugs.python.org/issue1657 Will commit a patch soon. ---------- assignee: docs@python components: Documentation messages: 196953 nosy: docs@python, giampaolo.rodola priority: normal severity: normal status: open title: select.poll.modify is not documented versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18925> _______________________________________

4 3

[issue27088] doc: select: epoll.poll: incorrect timeout units, missing maxevents
by Steve Ford Aug. 19, 2018

Aug. 19, 2018

New submission from Steve Ford: The short description of epoll.poll is correct (gives timeout unit as seconds [float]; includes maxevents). However, the long description lists the timeout units as milliseconds ("If timeout is given, it specifies the length of time in milliseconds which the system will wait for events before returning."), and does not include maxevents at all. See https://docs.python.org/3.5/library/select.html#select.poll.poll See also https://docs.python.org/2.7/library/select.html#select.poll.poll ---------- assignee: docs@python components: Documentation messages: 266118 nosy: docs@python, fordsfords priority: normal severity: normal status: open title: doc: select: epoll.poll: incorrect timeout units, missing maxevents versions: Python 2.7, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27088> _______________________________________

2 1

[issue22057] The doc say all globals are copied on eval(), but only __builtins__ is copied
by Alon Mishne Aug. 19, 2018

Aug. 19, 2018

New submission from Alon Mishne: According to the documentation of eval(): > If the globals dictionary is present and lacks '__builtins__', the current globals are copied into globals before expression is parsed. However in practice only the __builtins__ items are copied, see: http://hg.python.org/cpython/file/2.7/Python/bltinmodule.c#l655 See http://stackoverflow.com/q/24934908/242762 ---------- assignee: docs@python components: Documentation messages: 223837 nosy: amishne, docs@python priority: normal severity: normal status: open title: The doc say all globals are copied on eval(), but only __builtins__ is copied versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22057> _______________________________________

6 14

[issue26363] __builtins__ propagation is misleading described in exec and eval documentation
by Xavier Combelle Aug. 19, 2018

Aug. 19, 2018

New submission from Xavier Combelle: According to my experiment in code, the current behavior of python3.5 is different that the document says. If I understand well the purpose of this behavior is to propagate the __builtins__ global constant if globals has not one. In https://docs.python.org/3.6/library/functions.html#eval it is written "If the globals dictionary is present and lacks ‘__builtins__’, the current globals are copied into globals before expression is parsed." only the __builtins__ looks copied not all the globals In https://docs.python.org/3.6/library/functions.html#exec It is written: "If the globals dictionary does not contain a value for the key __builtins__, a reference to the dictionary of the built-in module builtins is inserted under that key." it looks like it is not a reference to the built-in module builtin, but a reference to __builtin__ global ---------- title: builtins propagation is misleading described in exec and eval documentation -> __builtins__ propagation is misleading described in exec and eval documentation versions: +Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26363> _______________________________________

6 10

[issue27026] async/await keywords are missing from reference docs
by Hong Minhee Aug. 15, 2018

Aug. 15, 2018

New submission from Hong Minhee: The async/await keywords are missing from §2.3.1. Keywords in reference docs. The attached patch adds two missing keywords to Doc/reference/lexical_analysis.rst file. ---------- assignee: docs@python components: Documentation files: patch.diff hgrepos: 343 keywords: patch messages: 265593 nosy: docs@python, hongminhee priority: normal severity: normal status: open title: async/await keywords are missing from reference docs type: enhancement versions: Python 3.5, Python 3.6 Added file: http://bugs.python.org/file42856/patch.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27026> _______________________________________

3 2

[issue15258] argparse documentation: Improve optparse section regarding allow_interspersed_args
by Nefarious CodeMonkey, Jr. Aug. 14, 2018

Aug. 14, 2018

New submission from Nefarious CodeMonkey, Jr. <nejucomo(a)users.sourceforge.net>: It was not obvious from the documentation on argparse how to emulate the optparse.OptionParser.allow_interspersed_args feature. Please add something like the following to the section titled "Upgrading optparse code" (see: http://docs.python.org/library/argparse.html#upgrading-optparse-code ) """ * If the optparse code sets allow_interspersed_args to False, then add an argparse positional argument with nargs=argparse.REMAINDER """ ---------- assignee: docs@python components: Documentation messages: 164702 nosy: docs@python, nejucomo priority: normal severity: normal status: open title: argparse documentation: Improve optparse section regarding allow_interspersed_args type: enhancement versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15258> _______________________________________

5 4

[issue28044] Make the sidebar in the documentation follow the section automatically
by Batiste Aug. 8, 2018

Aug. 8, 2018

New submission from Batiste: Hi, Here is a small patch for the documentation that make the sidebar follow the headers while scrolling through a long page. http://imgur.com/UsrFAti Test on Chrome and Firefox. Seems to work like a charm. ---------- assignee: docs@python components: Documentation files: following-sidebar.patch keywords: patch messages: 275315 nosy: batiste, docs@python priority: normal severity: normal status: open title: Make the sidebar in the documentation follow the section automatically type: enhancement Added file: http://bugs.python.org/file44502/following-sidebar.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue28044> _______________________________________

5 10

[issue32258] Rewrite ayncio docs to use async/await syntax
by Andrew Svetlov Aug. 5, 2018

Aug. 5, 2018

New submission from Andrew Svetlov <andrew.svetlov(a)gmail.com>: https://bugs.python.org/issue32193 switched asyncio implementation to async/await syntax. We need to update documentation as well. ---------- assignee: docs@python components: Documentation, asyncio messages: 307889 nosy: asvetlov, docs@python, yselivanov priority: normal severity: normal status: open title: Rewrite ayncio docs to use async/await syntax versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32258> _______________________________________

3 5

[issue33736] Improve the documentation of asyncio stream API
by Yury Selivanov Aug. 4, 2018

Aug. 4, 2018

New submission from Yury Selivanov <yselivanov(a)gmail.com>: New changeset c0d062f523b16331444ff910e4596ee5608c8170 by Yury Selivanov (Elvis Pranskevichus) in branch 'master': bpo-33736: Improve the documentation of asyncio stream APIs (GH-7326) https://github.com/python/cpython/commit/c0d062f523b16331444ff910e4596ee560… ---------- nosy: +yselivanov _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33736> _______________________________________

3 3

[issue13574] refresh example in doc for Extending and Embedding
by Florent Xicluna Aug. 4, 2018

Aug. 4, 2018

New submission from Florent Xicluna <florent.xicluna(a)gmail.com>: The example uses PyInstanceObject which is Python 2 only (old-style classes). http://docs.python.org/dev/extending/newtypes.html#weak-reference-support ---------- assignee: docs@python components: Documentation, Extension Modules messages: 149183 nosy: docs@python, flox priority: normal severity: normal stage: needs patch status: open title: refresh example in doc for Extending and Embedding type: behavior versions: Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13574> _______________________________________

6 5