Mailman 3 March 2017 - docs

[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

[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

[issue27910] Doc/library/traceback.rst — references to tuples should be replaced with new FrameSummary object
by Tomas Orsava Aug. 2, 2018

Aug. 2, 2018

New submission from Tomas Orsava: In the documentation for the `traceback` module, the definitions of functions `extract_tb` [0], `format_list` [1] and classmethod `from_list` [2] mention the old style (4-)tuples that these functions used to return or accept. Since Python 3.5, however, they return or accept a FrameSummary object instead of the 4-tuple, or a StackSummary object instead of a list of 4-tuples. I'm including a patch that fixes these definitions to make them reflect the new reality. [0] https://docs.python.org/3.6/library/traceback.html#traceback.extract_tb [1] https://docs.python.org/3.6/library/traceback.html#traceback.format_list [2] https://docs.python.org/3.6/library/traceback.html#traceback.StackSummary.f… ---------- assignee: docs@python components: Documentation files: traceback-doc.patch keywords: patch messages: 274010 nosy: docs@python, torsava priority: normal severity: normal status: open title: Doc/library/traceback.rst — references to tuples should be replaced with new FrameSummary object versions: Python 3.5, Python 3.6 Added file: http://bugs.python.org/file44293/traceback-doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27910> _______________________________________

7 16

[issue27671] FAQ: len() is still function for good reason.
by INADA Naoki July 31, 2018

July 31, 2018

New submission from INADA Naoki: https://docs.python.org/3/faq/design.html#why-does-python-use-methods-for-s… > The major reason is history. ... > but it’s a part of Python, and it’s too late to make such fundamental changes now. The functions have to remain to avoid massive code breakage. People seeing this answer may think "it's bad design, but remains for historical reason." But there is more positive reason why len is still function. http://effbot.org/pyfaq/why-does-python-use-methods-for-some-functionality-… ---------- assignee: docs@python components: Documentation messages: 271881 nosy: docs@python, methane priority: normal severity: normal status: open title: FAQ: len() is still function for good reason. _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27671> _______________________________________

4 12

[issue29710] Incorrect representation caveat on bitwise operation docs
by Nick Coghlan July 28, 2018

July 28, 2018

New submission from Nick Coghlan: The docs on bitwise operations at https://docs.python.org/3/library/stdtypes.html#bitwise-operations-on-integ… include the caveated sentence: Negative numbers are treated as their 2’s complement value (this assumes that there are enough bits so that no overflow occurs during the operation). This sentence isn't correct now that integers are always arbitrary length. The bitwise inversion will never overflow, and is instead calculated as "-(n+1)" rather than literally flipping bits in the representation: https://docs.python.org/3/reference/expressions.html#unary-arithmetic-and-b… ---------- assignee: docs@python components: Documentation messages: 288890 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Incorrect representation caveat on bitwise operation docs type: enhancement versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29710> _______________________________________

7 35