Mailman 3 November 2019 - docs

[issue27408] Document importlib.abc.ExecutionLoader implements get_data()
by Brett Cannon Nov. 6, 2020

Nov. 6, 2020

New submission from Brett Cannon: The fact that importlib.abc.ExectionLoader.get_data() is implemented is missing (or put another way, it isn't documented that get_source() still needs to be implemented). ---------- assignee: docs@python components: Documentation messages: 269458 nosy: brett.cannon, docs@python priority: normal severity: normal stage: needs patch status: open title: Document importlib.abc.ExecutionLoader implements get_data() versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27408> _______________________________________

1 2

[issue13122] Out of date links in the sidebar of the documentation index of versions 3.1 and 3.2
by Sven Marnach Nov. 6, 2020

Nov. 6, 2020

New submission from Sven Marnach <sven(a)marnach.net>: The sidebar on http://docs.python.org/release/3.1.3/ names 3.2 as the development version of Python, while the link points to 3.3. The sidebar on http://docs.python.org/py3k/ links to 3.1 as the "stable version" -- obviously a relict from the time when 3.2 was in development. (This could be fixed in Doc/tools/sphinxext/indexsidebar.html of the respective branches.) ---------- assignee: docs@python components: Documentation messages: 145084 nosy: docs@python, smarnach priority: normal severity: normal status: open title: Out of date links in the sidebar of the documentation index of versions 3.1 and 3.2 versions: Python 3.1, Python 3.2 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue13122> _______________________________________

8 13

[issue11346] Generator object should be mentioned in gc module document
by Atsuo Ishimoto Nov. 6, 2020

Nov. 6, 2020

New submission from Atsuo Ishimoto <ishimoto(a)gembook.org>: In the gc.garbage of the library ref of gc module, ... this list contains only objects with __del__() methods. This is not true, since gc.garbage will contain generator object with try-finally block. ---------- assignee: docs@python components: Documentation messages: 129631 nosy: docs@python, ishimoto priority: normal severity: normal status: open title: Generator object should be mentioned in gc module document _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11346> _______________________________________

4 4

[issue37826] Document PEP 3134 in tutorials/errors.rst
by Abhilash Raj Nov. 5, 2020

Nov. 5, 2020

New submission from Abhilash Raj <raj.abhilash1(a)gmail.com>: Looking at the docs, I couldn't find the `raise from` documentation anywhere in the Errors and Exceptions page (https://docs.python.org/3/tutorial/errors.html) page, which seems to be the landing page for Python Exceptions. I do see however that it is documented on the top page of https://docs.python.org/3/library/exceptions.html and raise statement's docs (https://docs.python.org/3/reference/simple_stmts.html#raise), both of which are pretty hard to discover. It would be nice to add the docs for `raise from` in the Errors and Exception page too. ---------- assignee: docs@python components: Documentation messages: 349406 nosy: docs@python, maxking priority: normal severity: normal status: open title: Document PEP 3134 in tutorials/errors.rst _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37826> _______________________________________

4 6

[issue26205] Inconsistency concerning nested scopes
by Roscoe R.Higgins Nov. 4, 2020

Nov. 4, 2020

New submission from Roscoe R.Higgins: In chapter 9. Classes of the Python3.5 documentation it says: "At any time during execution, there are at least three nested scopes whose namespaces are directly accessible:", followed by a list containing 4 items. Further down a middle scope is mentioned (although mentioned by name). This was confusing for a while. ---------- assignee: docs@python components: Documentation messages: 258941 nosy: Roscoe R. Higgins, docs@python priority: normal severity: normal status: open title: Inconsistency concerning nested scopes type: behavior versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue26205> _______________________________________

10 26

[issue14379] Several traceback docs improvements
by anatoly techtonik Nov. 4, 2020

Nov. 4, 2020

New submission from anatoly techtonik <techtonik(a)gmail.com>: Some notes about current `traceback` documentation: http://docs.python.org/library/traceback.html 1. It needs a mentioning that traceback module works with traceback objects and frame objects 2. Functions that work with frames should probably be grouped together 3. Docs for frame function should include info about where to get frames (e.g. http://docs.python.org/library/inspect.html#the-interpreter-stack) 4. There is no traceback object description, which should be at http://docs.python.org/library/sys.html#sys.exc_info ---------- assignee: docs@python components: Documentation messages: 156486 nosy: docs@python, techtonik priority: normal severity: normal status: open title: Several traceback docs improvements _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14379> _______________________________________

4 4

[issue9499] Python C/API Execution namespace undocumented. (patch included)
by Campbell Barton Nov. 2, 2020

Nov. 2, 2020

New submission from Campbell Barton <ideasman42(a)gmail.com>: Some parts of the python api expect __main__ module dictionary to be the namespace when executing a script, this is true when running a python script from the python binary but NOT true when running a compiled script from the C/API which can lead to bugs which are not easy to solve unless the C/API author knows this. ---------- assignee: docs@python components: Documentation files: doc_py3_main_mod.diff keywords: patch messages: 112706 nosy: docs@python, ideasman42 priority: normal severity: normal status: open title: Python C/API Execution namespace undocumented. (patch included) type: behavior versions: Python 3.2 Added file: http://bugs.python.org/file18357/doc_py3_main_mod.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9499> _______________________________________

3 4

[issue14219] start the Class tutorial in a more gentle manner
by Tshepang Lekhonkhobe Nov. 1, 2020

Nov. 1, 2020

New submission from Tshepang Lekhonkhobe <tshepang(a)gmail.com>: Looking at Doc/tutorial/classes, the section "Python Scopes and Namespaces" is full of heavy/deep information. I expect that people who would be able to properly digest that info are people who are already advanced at Python, and therefore maybe it should be moved to some cookbook (or language reference). I would prefer something gentler, since the tutorial is for Python newbies who aren't necessarily conversant with OO concepts. There can of course be links to heavier material for deeper understanding. ---------- assignee: docs@python components: Documentation messages: 155065 nosy: docs@python, tshepang priority: normal severity: normal status: open title: start the Class tutorial in a more gentle manner type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14219> _______________________________________

4 5

[issue33300] Bad usage example in id() DocString
by Glen Neff Oct. 31, 2020

Oct. 31, 2020

New submission from Glen Neff <gneff(a)trioptimum.com>: The DocString for id() in 3.5.x & 3.6.x seems to have an incorrect usage example, specifically ``id(obj, /)``. This is present in 3.5.x & 3.6.x. It does not appear to be present in 2.7.x or 3.4.x.: Python 3.6.4 (v3.6.4:d48eceb, Dec 19 2017, 06:54:40) [MSC v.1900 64 bit (AMD64)] on win32 Type "help", "copyright", "credits" or "license" for more information. >>> help(id) Help on built-in function id in module builtins: id(obj, /) Return the identity of an object. This is guaranteed to be unique among simultaneously existing objects. (CPython uses the object's memory address.) >>> ---------- assignee: docs@python components: Documentation messages: 315410 nosy: docs@python, gneff priority: normal severity: normal status: open title: Bad usage example in id() DocString versions: Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33300> _______________________________________

3 3

[issue21078] multiprocessing.managers.BaseManager.__init__'s "serializer" argument is not documented
by Yuriy Taraday Oct. 30, 2020

Oct. 30, 2020

New submission from Yuriy Taraday: We're going to use BaseManager for simple secure local RPC and for the "secure" part we can't use pickle, so we have to use "serializer" argument to switch to xmlrpclib. We need to be sure that argument won't go away so we need it to be documented and supported on future versions. ---------- assignee: docs@python components: Documentation messages: 214967 nosy: docs@python, yorik.sar priority: normal severity: normal status: open title: multiprocessing.managers.BaseManager.__init__'s "serializer" argument is not documented 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/issue21078> _______________________________________

5 7