Mailman 3 May 2020 - docs

[issue40372] doctest example programs should exit 1 if any test fails
by Andreas Sommer May 24, 2020

May 24, 2020

New submission from Andreas Sommer <andreas.sommer87(a)googlemail.com>: Documentation recommends calling `doctest.testmod()`, but exits with code 0 even if a test fails. ---------- assignee: docs@python components: Documentation messages: 367086 nosy: Andreas Sommer, docs@python priority: normal severity: normal status: open title: doctest example programs should exit 1 if any test fails type: enhancement versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40372> _______________________________________

4 3

[issue40160] documentation example of os.walk should be less destructive
by John Taylor May 24, 2020

May 24, 2020

New submission from John Taylor <johntaylor(a)gmail.com>: The example for os.walkdir should be less destructive. It currently recursively removes all files and directories. I will be submitting a PR on GitHub. ---------- assignee: docs@python components: Documentation messages: 365625 nosy: docs@python, jftuga priority: normal severity: normal status: open title: documentation example of os.walk should be less destructive versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40160> _______________________________________

5 10

[issue37973] improve docstrings of sys.float_info
by Sergey Fedoseev May 24, 2020

May 24, 2020

New submission from Sergey Fedoseev <fedoseev.sergey(a)gmail.com>: In [8]: help(sys.float_info) ... | | dig | DBL_DIG -- digits | This is not very helpful, https://docs.python.org/3/library/sys.html#sys.float_info is more verbose, so probably docstrings should be updated from where. ---------- assignee: docs@python components: Documentation messages: 350703 nosy: docs@python, sir-sigurd priority: normal severity: normal status: open title: improve docstrings of sys.float_info type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37973> _______________________________________

5 8

[issue40405] ast
by Bar Harel May 23, 2020

May 23, 2020

New submission from Bar Harel <bzvi7919(a)gmail.com>: Continuing with bpo-27589, looks like as_completed documentation is still misleading. According to the docs, it "Return(s) an iterator of Future objects. Each Future object returned represents the earliest result from the set of the remaining awaitables." There's only one problem: The only thing it definitely doesn't do, is return an iterator of future objects. To be honest with you, I'm not entirely sure how to phrase it. For reference, I fell for this: mapping = {fut: index for fut, index in enumerate(futures)} for fut in as_completed(mapping): mapping[fut] # KeyError ---------- assignee: docs@python components: Documentation, asyncio messages: 367410 nosy: aronacher, asvetlov, bar.harel, docs@python, gvanrossum, hynek, vstinner, xtreak, yselivanov priority: normal severity: normal status: open title: ast versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40405> _______________________________________

6 20

[issue40057] Missing mention of some class attributes in socketserver documentation
by OverMighty May 23, 2020

May 23, 2020

New submission from OverMighty <its.overmighty(a)gmail.com>: The documentation of the `socketserver` module of the Python standard library, available here: https://docs.python.org/3/library/socketserver.html, doesn't mention the existence of the following class attributes: StreamRequestHandler.connection (defined at line 764 of socketserver.py) DatagramRequestHandler.packet (defined at line 812 of socketserver.py) DatagramRequestHandler.socket (defined at line 812 of socketserver.py) ---------- assignee: docs@python components: Documentation messages: 364962 nosy: docs@python, overmighty priority: normal severity: normal status: open title: Missing mention of some class attributes in socketserver documentation type: enhancement versions: Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40057> _______________________________________

2 2

[issue40733] mention IDLE in main python ocs page
by paul rubin May 23, 2020

May 23, 2020

New submission from paul rubin <phr-pythonbugs(a)nightsong.com>: The IDLE documentation is in https://docs.python.org/3/library/idle.html which is not where I'd have thought to look for it, since I think of IDLE as an application rather than a library. So I looked for it on the main docs page, docs.python.org, and didn't find it there. I ended up finding it by web search. I guess its current location is reasonable, but maybe a link to it could be included in docs.python.org's main page left side navigation panel, or IDLE could simply be mentioned in the entry for library documentation. ---------- assignee: docs@python components: Documentation messages: 369640 nosy: docs@python, phr priority: normal severity: normal status: open title: mention IDLE in main python ocs page type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40733> _______________________________________

5 8

[issue40678] Full list of Python lexical rules
by Ram Rachum May 23, 2020

May 23, 2020

New submission from Ram Rachum <ram(a)rachum.com>: I'm a noob on parsing, learning about it, so it's possible I've made a mistake somewhere. I know there's this page: https://docs.python.org/3/reference/grammar.html Which is a full listing of Python's grammar. However, looking at this page: https://docs.python.org/3/reference/lexical_analysis.html I see rules that aren't written there, like longstringitem. I'm guessing that's because these are lexing rules, while the former was a list of parsing rules? If that's the case, shouldn't there also be a full, authoritative list of Python's lexical rules? Possibly alongside the parsing rules? ---------- assignee: docs@python components: Documentation messages: 369320 nosy: cool-RR, docs@python, georg.brandl, gvanrossum priority: normal severity: normal status: open title: Full list of Python lexical rules type: enhancement versions: Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40678> _______________________________________

2 5

[issue40646] Builtins in doc show signature in documentation
by Henk-Jaap Wagenaar May 23, 2020

May 23, 2020

New submission from Henk-Jaap Wagenaar <wagenaarhenkjaap(a)gmail.com>: Due to a certain discussion on extending zip, I was having looking at this page: https://docs.python.org/3/library/functions.html It lists the builtins at the top as e.g. all() which I think is confusing: running all() will actually fail. I think it should either (using "all" as example): 1. display as "all" 2. display as "all(iterable)" (what to do about 'overloaded' functions like e.g. range?) I am happy to provide a PR for the preferred option. ---------- assignee: docs@python components: Documentation messages: 369053 nosy: cryvate, docs@python priority: normal severity: normal status: open title: Builtins in doc show signature in documentation type: enhancement versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40646> _______________________________________

4 5

[issue40439] Error in an external reference
by Patrick A. May 23, 2020

May 23, 2020

New submission from Patrick A. <paudemard(a)gmail.com>: This URL doesn't exist anymore. If you click on this URL you have a 404 not found. https://www.dcl.hpi.uni-potsdam.de/home/loewis/table-3131.html The website was changed and Dr. Martin v. Löwis is not hosted on the new site. Regards ---------- assignee: docs@python components: Documentation messages: 367665 nosy: audpa31, docs@python priority: normal severity: normal status: open title: Error in an external reference versions: Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40439> _______________________________________

5 10

[issue40552] Enhance for loop and copy example in tutorial
by Julien Palard May 23, 2020

May 23, 2020

New submission from Julien Palard <julien+python(a)palard.fr>: During the past few weeks we got two reports of an example not working in the tutorial: [1], [2]. [1]: https://mail.python.org/archives/list/docs@python.org/message/ZJM3S2TE5UPFY… [2]: https://mail.python.org/archives/list/docs@python.org/thread/6FZ55HTMILK4P6… Problem is: the example uses a `users` variable that is not defined. users should be a dict, which is not straightforward for newcomers neither, so I propose to define it to: users = {"Hans": "active", "Andrea": "inactive", "Nils": "active"} in the example, to make it work. ---------- assignee: docs@python components: Documentation keywords: easy messages: 368373 nosy: docs@python, mdk priority: low severity: normal status: open title: Enhance for loop and copy example in tutorial type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40552> _______________________________________

3 4