Mailman 3 August 2019 - docs

[issue37799] Renaming Doc/reference/ to Doc/language/
by Géry Aug. 10, 2019

Aug. 10, 2019

New submission from Géry <gery.ogam(a)gmail.com>: The page https://docs.python.org/3/ lists these two parts: - Library Reference - Language Reference So both parts are "references". However in the cpython GitHub repository, the Doc/ directory contains these two directories: - library/ - reference/ So to be consistent, shouldn't we rename the Doc/reference/ directory to Doc/language/? ---------- assignee: docs@python components: Documentation messages: 349280 nosy: docs@python, maggyero priority: normal severity: normal status: open title: Renaming Doc/reference/ to Doc/language/ versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37799> _______________________________________

3 3

[issue37800] Clean up the documentation on module attributes
by Géry Aug. 9, 2019

Aug. 9, 2019

Change by Géry <gery.ogam(a)gmail.com>: ---------- assignee: docs@python components: Documentation nosy: docs@python, eric.snow, maggyero priority: normal pull_requests: 14923 severity: normal status: open title: Clean up the documentation on module attributes type: enhancement versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37800> _______________________________________

1 0

[issue23560] Group the docs of similar methods in stdtypes.rst
by Ezio Melotti Aug. 9, 2019

Aug. 9, 2019

New submission from Ezio Melotti: The Doc/library/stdtypes.rst page describes in detail the built-in types and their methods. As suggested in #21777 (see the comments on Rietveld), it might be a good idea to group the documentation of some similar methods, such as {r|l|}just, {r|l|}strip, {r|}partition, {r|}index, and {r|}find. This will remove some duplication, make the page shorter and easier to navigate, and make the methods easier to discover. Adding tables containing the methods for each types has also been proposed. ---------- assignee: docs@python components: Documentation keywords: easy messages: 237036 nosy: docs@python, ezio.melotti priority: normal severity: normal stage: needs patch status: open title: Group the docs of similar methods in stdtypes.rst type: enhancement versions: Python 2.7, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23560> _______________________________________

6 9

[issue37779] configparser: add documentation about several read() behaviour
by Stéphane Blondon Aug. 8, 2019

Aug. 8, 2019

Stéphane Blondon <stephane.blondon(a)gmail.com> added the comment: Thank you for the idea. :) I committed something else, based on the previous example of the 'Quick Start' section. What do you think about it? ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37779> _______________________________________

1 0

[issue37793] argparse uses "container object", should be "iterable"
by Eric V. Smith Aug. 8, 2019

Aug. 8, 2019

New submission from Eric V. Smith <eric(a)trueblade.com>: https://docs.python.org/3/library/argparse.html#choices says "These can be handled by passing a container object as the choices keyword argument to add_argument()". I think this should be "iterable" instead. Internally, argparse reads the iterable and converts it to a list so that it can read it multiple times (among other reasons, I'm sure). One of the examples uses range(), which is not a container. "container" is also used in https://docs.python.org/3/library/argparse.html#the-add-argument-method Bonus points for fixing the docstring in argparse.py. I didn't check if anywhere else in that file needs to be fixed. ---------- assignee: docs@python components: Documentation keywords: newcomer friendly messages: 349234 nosy: docs@python, eric.smith priority: normal severity: normal status: open title: argparse uses "container object", should be "iterable" versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37793> _______________________________________

2 6

[issue37779] configparser: add documentation about several read() behaviour
by Stéphane Blondon Aug. 8, 2019

Aug. 8, 2019

Change by Stéphane Blondon <stephane.blondon(a)gmail.com>: ---------- keywords: +patch pull_requests: +14908 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/15177 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37779> _______________________________________

1 0

[issue11165] Document PyEval_Call* functions
by Nick Coghlan Aug. 8, 2019

Aug. 8, 2019

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: There are currently undocumented PyEval_Call* equivalents to a number of the PyObject_Call* functions. Since there are resources out there on the web that direct people to use the currently undocumented PyEval functions, it would be good to document those properly, and recommend people typically use the PyObject_Call* variants instead (as the latter include all the stack and interpreter state integrity protection code, while the PyEval variants assume that has all already been handled). ---------- assignee: docs@python components: Documentation keywords: easy messages: 128248 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Document PyEval_Call* functions versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue11165> _______________________________________

9 12

[issue18578] Rename and document test.bytecode_helper as test.support.bytecode_helper
by Joannah Nanjekye Aug. 7, 2019

Aug. 7, 2019

Change by Joannah Nanjekye <nanjekyejoannah(a)gmail.com>: ---------- pull_requests: +14900 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/15168 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue18578> _______________________________________

1 0

[issue37789] Update doc strings for test.bytecode_helper
by Joannah Nanjekye Aug. 7, 2019

Aug. 7, 2019

Joannah Nanjekye <nanjekyejoannah(a)gmail.com> added the comment: *supposed not supported. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37789> _______________________________________

1 0

[issue37789] Update doc strings for test.bytecode_helper
by Joannah Nanjekye Aug. 7, 2019

Aug. 7, 2019

Change by Joannah Nanjekye <nanjekyejoannah(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python versions: +Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue37789> _______________________________________

1 0