Mailman 3 April 2022 - Docs-bugs

[issue47236] Document types.CodeType.replace() changes about co_exceptiontable
by STINNER Victor 05 Apr '22

05 Apr '22

New submission from STINNER Victor <vstinner(a)python.org>: It would be nice to document the bpo-40222 changes in What's New in Python 3.11 and in the CodeType documentation: * https://docs.python.org/dev/library/types.html#types.CodeType * https://docs.python.org/dev/whatsnew/3.11.html Users of types.CodeType.replace(co_code=new_code) must now pass co_exceptiontable or exception handling will no longer work as expected. Callers are responsible to build co_exceptiontable. Currently, the format of this table is documented at: https://github.com/python/cpython/blob/main/Objects/exception_handling_note… There is no public function to encode this table, it's also the responsibility of the caller. See also bpo-47185 "code.replace(co_code=new_code) no longer catch exceptions on Python 3.11" closed as "won't fix" for the background. ---------- assignee: docs@python components: Documentation messages: 416831 nosy: docs@python, vstinner priority: normal severity: normal status: open title: Document types.CodeType.replace() changes about co_exceptiontable versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47236> _______________________________________

2 1

[issue47184] multiprocessing.set_start_method force argument is not documented
by John Hagen 05 Apr '22

05 Apr '22

New submission from John Hagen <johnthagen(a)gmail.com>: multiprocessing.set_start_method() has a `force` argument that is not documented: https://docs.python.org/3.10/library/multiprocessing.html#multiprocessing.s… ---------- assignee: docs@python components: Documentation messages: 416451 nosy: John Hagen, docs@python priority: normal severity: normal status: open title: multiprocessing.set_start_method force argument is not documented type: enhancement versions: Python 3.10, Python 3.11, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47184> _______________________________________

2 2

[issue46168] Incorrect format specified for the "style" key in the configuration file format formatter example
by David Bereza 05 Apr '22

05 Apr '22

New submission from David Bereza <bokunogf(a)gmail.com>: Documentation link: https://docs.python.org/3/library/logging.config.html#configuration-file-fo… It seems that the example for the "formatter_form01" formatter section specifies following for the style(please note the single-quotes around the value). style='%' This seems to raise a ValueError with the message "Style must be one of..." when parsing the configuration file. Removing the single quotes seems to fix the issue: style=% ---------- assignee: docs@python components: Documentation messages: 409108 nosy: bokunogf, docs@python priority: normal severity: normal status: open title: Incorrect format specified for the "style" key in the configuration file format formatter example versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue46168> _______________________________________

4 3

[issue44158] Clarify documentation for redirected stdout/stderr when using subprocess in Linux
by Stanley 05 Apr '22

05 Apr '22

Stanley <ostanley.lee(a)gmail.com> added the comment: Hmm, I'm not quite following - when you say that the subproccess-ed command should also inherit the redirection, which subprocess command are you referring to, and nested or unnested? I gave it a ran and everything seems to run how I'd expected it, so maybe put another way, what's the expected output from the files and stdout/stderr? ---------- nosy: +slateny _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44158> _______________________________________

1 0

[issue21956] Doc files deleted from repo are not deleted from docs.python.org.
by Julien Palard 05 Apr '22

05 Apr '22

Julien Palard <julien+python(a)palard.fr> added the comment: This is resolved since https://github.com/python/docsbuild-scripts/pull/28. It could still happen in very specific conditions, but not for a long time, see: https://github.com/python/docs-community/issues/41#issuecomment-1088462199= ---------- nosy: +mdk resolution: -> fixed stage: -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue21956> _______________________________________

1 0

[issue28951] re.flags not documented in Module Contents as promised.
by Irit Katriel 05 Apr '22

05 Apr '22

Change by Irit Katriel <iritkatriel(a)gmail.com>: ---------- keywords: +easy versions: +Python 3.10, Python 3.11, Python 3.9 -Python 2.7, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue28951> _______________________________________

1 0

[issue47207] Switch datetime docstrings / documentation to using "Returns" rather than "Return"?
by Paul Ganssle 05 Apr '22

05 Apr '22

New submission from Paul Ganssle <bpo(a)m.ganssle.io>: In bpo-9305, Fred Drake recommends preferring `Returns ...` over the imperative `Return ...`: https://bugs.python.org/issue9305#msg110912 Currently we're pretty consistent about `Return ...`, which is consistent with PEP 257: https://peps.python.org/pep-0257/ That said, I actually think "Returns ..." sounds much better in the documentation, and I'd be happy to see it changed if others agree. I have spun this off from bpo-9305 so that we can unblock https://github.com/python/cpython/pull/31697. ---------- assignee: docs@python components: Documentation messages: 416628 nosy: belopolsky, docs@python, fdrake, p-ganssle, slateny priority: normal severity: normal status: open title: Switch datetime docstrings / documentation to using "Returns" rather than "Return"? versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47207> _______________________________________

2 1

[issue45790] Inaccurate phrasing in extending/newtypes_tutorial
by Rodrigo Tobar 05 Apr '22

05 Apr '22

New submission from Rodrigo Tobar <rtobarc(a)gmail.com>: In `extending/newtypes_tutorial.rst` the following phrase appears: "[...], containing a pointer to a type object and a reference count (these can be accessed using the macros :c:macro:`Py_REFCNT` and c:macro:`Py_TYPE` respectively)." I believe it should read "using the macros :c:macro:`Py_TYPE` and c:macro:`Py_REFCNT` respectively" to follow the same order in which the fields are described. I'll put forward a patch. It seems this phrase goes way back a few python versions, but I'm tagging 3.11 here only. ---------- assignee: docs@python components: Documentation messages: 406185 nosy: docs@python, rtobar2 priority: normal severity: normal status: open title: Inaccurate phrasing in extending/newtypes_tutorial versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45790> _______________________________________

4 7

[issue40982] copytree example in shutil
by miss-islington 05 Apr '22

05 Apr '22

miss-islington <mariatta.wijaya+miss-islington(a)gmail.com> added the comment: New changeset bc9ec24290d0fa823fa2ac19ac9767b2b8498faa by Miss Islington (bot) in branch '3.9': bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778) https://github.com/python/cpython/commit/bc9ec24290d0fa823fa2ac19ac9767b2b8… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40982> _______________________________________

1 0

[issue40982] copytree example in shutil
by miss-islington 05 Apr '22

05 Apr '22

miss-islington <mariatta.wijaya+miss-islington(a)gmail.com> added the comment: New changeset 857cf55cbdd65b7a9534dc35d89a19dfe8cbdba5 by Miss Islington (bot) in branch '3.10': bpo-40982: shutil docs: Remove outdated copytree() example (GH-24778) https://github.com/python/cpython/commit/857cf55cbdd65b7a9534dc35d89a19dfe8… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40982> _______________________________________

1 0