Mailman 3 March 2020 - docs

[issue39945] Wrong example result in docs
by Tomas Hak 12 Mar '20

12 Mar '20

New submission from Tomas Hak <thak(a)tom-sec.com>: Step to reproduce: Open page: https://docs.python.org/3/library/sched.html Location: Documentation : sched — Event scheduler Description: In the text is definition of priority: "Events scheduled for the same time will be executed in the order of their priority. A lower number represents a higher priority." I assume it is correct, but example shows different behavior. There are scheduled two events with priority two and one. In print on the end of example, they are in wrong order : Code: s.enter(5, 2, print_time, argument=('positional',)) s.enter(5, 1, print_time, kwargs={'a': 'keyword'}) Current Result: >From print_time 930343695.274 positional >From print_time 930343695.275 keyword Expected result: >From print_time 930343695.274 keyword >From print_time 930343695.275 positional Conclusion : I tested the example code and it gave me expected result in order "keyword","positional" ---------- assignee: docs@python components: Documentation messages: 364004 nosy: docs@python, hook priority: normal severity: normal status: open title: Wrong example result in docs versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39945> _______________________________________

2 2

[issue20039] Missing documentation for argparse.ArgumentTypeError
by Arnaut Billings 11 Mar '20

11 Mar '20

New submission from Arnaut Billings: There is no documentation for argparse.ArgumentTypeError: http://docs.python.org/3/library/unittest.html Though it does appear in an example and its usage is simple enough to decipher what it means, it would none the less look more professional if there was formal documentation for it. Not only on what it is, but when it should actually be used, etc... ---------- assignee: docs@python components: Documentation messages: 206723 nosy: arnaut-billings, docs@python priority: normal severity: normal status: open title: Missing documentation for argparse.ArgumentTypeError versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue20039> _______________________________________

5 6

[issue39935] argparse: help parameter not documented in add_subparsers().add_parser
by Nazime Koussaila Lakehal 11 Mar '20

11 Mar '20

New submission from Nazime Koussaila Lakehal <nazime.lkh(a)gmail.com>: The parameter help in the method add_parser of _SubParsersAction (that we obtain with ArgumentParser.add_subparsers()) Is not documented. In the documentation we can find: The add_subparsers() method is normally called with no arguments and returns a special action object. This object has a single method, add_parser(), which takes a command name and any ArgumentParser constructor arguments, and returns an ArgumentParser object that can be modified as usual. I found the parameter by accident and then I checked in the source code, it's unfortunate because the help parameter give really nice output when having sub commands. the parameter 'aliases' is also not documented. ---------- assignee: docs@python components: Documentation messages: 363932 nosy: Nazime Koussaila Lakehal, docs@python priority: normal severity: normal status: open title: argparse: help parameter not documented in add_subparsers().add_parser 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/issue39935> _______________________________________

3 2

[issue39808] pathlib: reword docs for stat()
by swgmma 10 Mar '20

10 Mar '20

New submission from swgmma <jason.nader(a)protonmail.com>: The docs for stat() (https://docs.python.org/3.9/library/pathlib.html#pathlib.Path.stat) state: > Return information about this path (similarly to os.stat()). The result is looked up at each call to this method." Nit picks: 1) It states "similarly to os.stat()" which implies there may be differences between the two, when in fact they both return the same `os.stat_result` object. 2) It should mention that `stat()` returns a `os.stat_result` object without having to go digging into the docs for `os` to find out. ---------- assignee: docs@python components: Documentation messages: 363052 nosy: docs@python, swgmma priority: normal severity: normal status: open title: pathlib: reword docs for stat() 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/issue39808> _______________________________________

4 9

[issue17422] language reference should specify restrictions on class namespace
by Eric Snow 10 Mar '20

10 Mar '20

New submission from Eric Snow: (related to PEP 422 and issue #17044) The execution namespace from a class definition is passed as the third argument to the metaclass (see builtin___build_class__() in Python/bltinmodule.c). When applicable, which is almost always, the subsequent call to type.__new__() copies that namespace into a new dict which is in turn exposed via the class's __dict__. This matters in the case where a metaclass with __prepare__() gets used (or the PEP 422 equivalent). The language reference[1] should note that the object returned by __prepare__() is copied into a new dict when the class is finally created via the metaclass. [1] http://docs.python.org/3.4/reference/datamodel.html#customizing-class-creat… ---------- assignee: docs@python components: Documentation messages: 184188 nosy: docs@python, eric.snow, ncoghlan priority: normal severity: normal stage: needs patch status: open title: language reference should specify restrictions on class namespace type: enhancement versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue17422> _______________________________________

8 25

datetime.html typo
by Simon Hren 09 Mar '20

09 Mar '20

olo, page: https://docs.python.org/3/library/datetime.html is believed to be found guilty: A time <https://docs.python.org/3/library/datetime.html#datetime.time> object *t* is aware if both of the following hold: 1. t.tzinfo is not None 2. t.tzinfo.utcoffset(*None*) does not return None. aj believe it should be 't', ja? thx for sharing, best regards, simon s love nia

1 0

[issue39914] logging.config: '.' (dot) as a key is not documented
by Yuta Okamoto 09 Mar '20

09 Mar '20

New submission from Yuta Okamoto <okapies(a)gmail.com>: I noticed that Configurators in logging.config module accepts '.' (dot) as a key to fill attributes for filters, formatters, and handlers directly like the following: handlers: syslog: class: logging.handlers.SysLogHandler .: ident: 'app-name: ' https://github.com/python/cpython/blob/46abfc1416ff8e450999611ef8f231ff871a… But it seems this functionality is not documented in https://docs.python.org/3/library/logging.config.html ---------- assignee: docs@python components: Documentation messages: 363744 nosy: Yuta Okamoto, docs@python priority: normal severity: normal status: open title: logging.config: '.' (dot) as a key is not documented 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/issue39914> _______________________________________

2 1

[issue39913] Document warnings.WarningMessage ?
by daniel hahler 09 Mar '20

09 Mar '20

New submission from daniel hahler <python-bugs(a)thequod.de>: I've noticed that `warnings.WarningMessage` is not documented, i.e. it does not show up in the intersphinx object list. I'm not sure how to document it best, but maybe just describing its attributes? Ref: https://github.com/blueyed/cpython/blob/598d29c51c7b5a77f71eed0f615eb0b3865… ---------- assignee: docs@python components: Documentation messages: 363735 nosy: blueyed, docs@python priority: normal severity: normal status: open title: Document warnings.WarningMessage ? _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39913> _______________________________________

2 1

[issue13077] Unclear behavior of daemon threads on main thread exit
by etuardu 09 Mar '20

09 Mar '20

New submission from etuardu <edonan(a)gmail.com>: The definition of daemon thread in the current documentation reads: «A thread can be flagged as a "daemon thread". The significance of this flag is that the entire Python program exits when only daemon threads are left. [...]» (http://docs.python.org/library/threading.html#thread-objects) I think it's not very clear from this that daemon threads themselves terminate when the program (main thread plus other non-daemon threads) terminates. I think this have to be said more explicitly. I'd propose a change with something like: «A thread can be flagged as a "daemon thread", which means it will get shut down when the overall program terminates. The entire Python program exits when only daemon threads are left.» ---------- assignee: docs@python components: Documentation messages: 144691 nosy: docs@python, etuardu priority: normal severity: normal status: open title: Unclear behavior of daemon threads on main thread exit type: behavior 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/issue13077> _______________________________________

5 7

Documentation epub
by Daniel Rusk 08 Mar '20

08 Mar '20

So I just tried to download your documentation for python 3 by your epub link. I don't know how you generate your epub but you might want to review it, it seems to take an inordinate amount of time to load up on my devices (specifically in Okular on Linux, and Librera on Android). Once it does it works fine, but in the time that it took I'd came to think something had gone wrong. I'll probably just use another format for now.

1 0