Mailman 3 January 2021 - docs

Bug?
by Mrigank Shekhar Jan. 15, 2021

Jan. 15, 2021

As per 4.7.7. Documentation Strings: Here are some conventions about the content and formatting of documentation strings. The first line should always be a short, concise summary of the object’s purpose. For brevity, it should not explicitly state the object’s name or type, since these are available by other means (except if the name happens to be a verb describing a function’s operation). This line should begin with a capital letter and *end with a period*. The below code is missing *end with a period *in the docstring. Bug? URL: https://docs.python.org/3/tutorial/classes.html#class-objects class MyClass: """A simple example class""" i = 12345 def f(self): return 'hello world'

1 0

[issue41824] Docs for typing.ForwardRef don't state that it was added in 3.7
by Ken Jin Jan. 15, 2021

Jan. 15, 2021

Change by Ken Jin <kenjin4096(a)gmail.com>: ---------- keywords: +patch nosy: +kj nosy_count: 2.0 -> 3.0 pull_requests: +23048 stage: -> patch review pull_request: https://github.com/python/cpython/pull/24224 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41824> _______________________________________

1 0

[issue42922] Enlace a descripción de función 'dir' faltante
by Jose MONTES PEREZ Jan. 13, 2021

Jan. 13, 2021

New submission from Jose MONTES PEREZ <jmontesp.informatica(a)gmail.com>: En la tabla de enlaces a funciones de la página: https://docs.python.org/es/3/library/functions.html no existe un link a la función 'dir' tal como: https://docs.python.org/es/3/library/functions.html#dir en su lugar está duplicado el enlace a la función 'any' ---------- assignee: docs@python components: Documentation messages: 385007 nosy: docs@python, jmontesp.informatica priority: normal severity: normal status: open title: Enlace a descripción de función 'dir' faltante versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42922> _______________________________________

2 1

[issue42910] Wrong code appears in the type alias introduction
by Casuall Jan. 12, 2021

Jan. 12, 2021

New submission from Casuall <Smile_zjk(a)qq.com>: I learned about type aliases on the page（https://docs.python.org/3/library/typing.html）, and I found that following the code (Vector = list[float])in the tutorial, an error occurred (NameError: name 'typing' is not defined) when running. The following code has the same problem： ConnectionOptions = dict[str, str] Address = tuple[str, int] Server = tuple[Address, ConnectionOptions] I searched through google and found the correct code： from typing import List Vector = List[float] from typing import Dict, Tuple, Sequence ConnectionOptions = Dict[str, str] Address = Tuple[str, int] Server = Tuple[Address, ConnectionOptions] ---------- assignee: docs@python components: Documentation messages: 384944 nosy: Smile-zjk, docs@python priority: normal severity: normal status: open title: Wrong code appears in the type alias introduction _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42910> _______________________________________

2 3

[issue42880] ctypes: variadic function call still doesn't work on Apple Silicon
by Ronald Oussoren Jan. 12, 2021

Jan. 12, 2021

Change by Ronald Oussoren <ronaldoussoren(a)mac.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42880> _______________________________________

1 0

[issue42870] Document changed argparse output wrt optional arguments in What's new in Python 3.10
by Miro Hrončok Jan. 11, 2021

Jan. 11, 2021

New submission from Miro Hrončok <miro(a)hroncok.cz>: A followup from https://bugs.python.org/issue9694 Could the change in output please be mentioned on https://docs.python.org/3.10/whatsnew/3.10.html ? In Fedora, at least 3 packages fail tests because of the change: ipython: https://github.com/ipython/ipython/pull/12759 m2r: https://github.com/miyakogi/m2r/pull/62 sphinxcontrib-autoprogram: https://bugzilla.redhat.com/show_bug.cgi?id=1914341 Thanks. ---------- assignee: docs@python components: Documentation messages: 384699 nosy: docs@python, hroncok, paul.j3, rhettinger priority: normal severity: normal status: open title: Document changed argparse output wrt optional arguments in What's new in Python 3.10 versions: Python 3.10 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42870> _______________________________________

3 4

[issue17243] The changes made for issue 4074 should be documented
by Irit Katriel Jan. 11, 2021

Jan. 11, 2021

Change by Irit Katriel <iritkatriel(a)yahoo.com>: ---------- stage: needs patch -> resolved status: pending -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue17243> _______________________________________

1 0

[issue24711] Document getpass.getpass behavior on ^C
by Markus Unterwaditzer Jan. 11, 2021

Jan. 11, 2021

New submission from Markus Unterwaditzer: getpass.getpass doesn't enter a newline when the user aborts input with ^C, while input/raw_input does. This behavior is surprising and can lead to mis-formatting of subsequent output. However, since this behavior exists since 2.7 and applications may have started to rely on it, I'd add a note to the documentation. ---------- assignee: docs@python components: Documentation messages: 247302 nosy: docs@python, untitaker priority: normal severity: normal status: open title: Document getpass.getpass behavior on ^C versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24711> _______________________________________

2 2

[issue34804] Repetition of 'for example' in documentation
by Aydin Jan. 10, 2021

Jan. 10, 2021

New submission from Aydin <bagiyevaydin(a)gmail.com>: In the documentation of Python 3.7.0 there is an error in the usage of the world 'for example'. ---------- assignee: docs@python components: Documentation files: Functional Programming HOWTO — Python 3.7.0 documentation.png messages: 326418 nosy: docs@python, rarblack priority: normal severity: normal status: open title: Repetition of 'for example' in documentation versions: Python 3.7 Added file: https://bugs.python.org/file47825/Functional Programming HOWTO — Python 3.7.0 documentation.png _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue34804> _______________________________________

5 6

Rewritten Multiprocessing Header
by Adam Finkle Jan. 9, 2021

Jan. 9, 2021

Please replace the header of the first article of the multiprocessing module documentation with the following text: multiprocessing <https://docs.python.org/3/library/multiprocessing.html#module-multiprocessi…> is a package allowing the programmer to use multiple processors. By offering both local and remote concurrency and subprocesses instead of threads, it effectively side-steps the Global Interpreter Lock <https://docs.python.org/3/glossary.html#term-global-interpreter-lock> by using. It runs on both Unix and Windows. While the module spawns processes using an API resembling the threading <https://docs.python.org/3/library/threading.html#module-threading> module, it also introduces new APIs, chiefly the Pool <https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool…> object, which enables convenient parallel function execution across multiple input values by distributing input data across processes. The following example demonstrates the common practice of defining functions to be imported by multiple processes. This basic example of data parallelism using Pool <https://docs.python.org/3/library/multiprocessing.html#multiprocessing.pool…>,

1 0