Mailman 3 July 2021 - Docs-bugs

[issue44765] Misspelled Word In Docs
by Łukasz Langa July 29, 2021

July 29, 2021

Łukasz Langa <lukasz(a)langa.pl> added the comment: New changeset ccefa8a905c797e4a60078d5e1de846f929c6928 by Pavel in branch 'main': bpo-44765: [doc] fix typo (GH-27430) https://github.com/python/cpython/commit/ccefa8a905c797e4a60078d5e1de846f92… ---------- nosy: +lukasz.langa _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44765> _______________________________________

1 0

[issue44765] Misspelled Word In Docs
by pavel-lexyr July 28, 2021

July 28, 2021

Change by pavel-lexyr <pavel(a)lexyr.com>: ---------- keywords: +patch nosy: +pavel-lexyr nosy_count: 3.0 -> 4.0 pull_requests: +25959 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/27430 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44765> _______________________________________

2 1

[issue42167] Documentation for SETUP_WITH opcode is wrong
by Irit Katriel July 28, 2021

July 28, 2021

Change by Irit Katriel <iritkatriel(a)gmail.com>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42167> _______________________________________

1 0

[issue44765] Misspelled Word In Docs
by Zachary Ware July 28, 2021

July 28, 2021

Zachary Ware <zachary.ware(a)gmail.com> added the comment: This is at https://docs.python.org/3/library/http.server.html#http.server.BaseHTTPRequ…, which can be found in Doc/library/http.server.rst ---------- assignee: -> docs@python components: +Documentation keywords: +easy, newcomer friendly nosy: +docs@python, zach.ware stage: -> needs patch versions: +Python 3.10, Python 3.11, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44765> _______________________________________

1 0

[issue44763] "width defaults to 70." in textwrap.wrap documentation is repetitive.
by Jack DeVries July 28, 2021

July 28, 2021

New submission from Jack DeVries <jdevries3133(a)gmail.com>: The phrase "width defaults to 70." in the documentation for textwrap.wrap is repetitive, because that information is already communicated in the function signature. The desire to fix this came up this discussion around this PR: https://github.com/python/cpython/pull/26999#discussion_r678322870 I will attach a PR momentarily. ---------- assignee: docs@python components: Documentation messages: 398392 nosy: docs@python, jack__d priority: normal severity: normal status: open title: "width defaults to 70." in textwrap.wrap documentation is repetitive. type: enhancement versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44763> _______________________________________

3 8

[issue44754] Documentation for pop in Built-in Types
by Mark Gluzman July 28, 2021

July 28, 2021

New submission from Mark Gluzman <mg2289(a)cornell.edu>: Python documentation: v.3.9.6 The Python Standard Library >> Built-in Types >> Mutable Sequence Types The table says that 'pop' operation should be written as s.pop([i]) The right way to do it is s.pop(i) ---------- assignee: docs@python components: Documentation messages: 398329 nosy: docs@python, mark-gluzman priority: normal severity: normal status: open title: Documentation for pop in Built-in Types versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44754> _______________________________________

4 6

[issue44561] Some expired hyperlinks in Python documentation
by Steven Hsu July 28, 2021

July 28, 2021

New submission from Steven Hsu <hsuhaochun(a)gmail.com>: In https://github.com/python/cpython/blob/main/Doc/distributing/index.rst, there are three expired hyperlinks: .. _Project structure: \ https://packaging.python.org/tutorials/distributing-packages/ .. _Building and packaging the project: \ https://packaging.python.org/tutorials/distributing-packages/#packaging-you… .. _Uploading the project to the Python Packaging Index: \ https://packaging.python.org/tutorials/distributing-packages/#uploading-you… And it should be fixed in this way: .. _Project structure: \ https://packaging.python.org/tutorials/packaging-projects/#packaging-python… .. _Building and packaging the project: \ https://packaging.python.org/tutorials/packaging-projects/#creating-the-pac… .. _Uploading the project to the Python Packaging Index: \ https://packaging.python.org/tutorials/packaging-projects/#uploading-the-di… Thanks. ---------- assignee: docs@python components: Documentation files: index.rst messages: 396941 nosy: StevenHsuYL, docs@python priority: normal severity: normal status: open title: Some expired hyperlinks in Python documentation type: enhancement versions: Python 3.9 Added file: https://bugs.python.org/file50139/index.rst _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44561> _______________________________________

5 14

[issue44388] venv API Docs for EnvBuilder.ensure_directories incorrectly describe behavior
by Matthew Clapp July 28, 2021

July 28, 2021

New submission from Matthew Clapp <itsayellow+dev(a)gmail.com>: The docs for the venv module, EnvBuilder class, ensure_directories method, describe behavior that doesn't match what its actual behavior is, (and what the code is). I propose to update the documentation of the API to match the actual behavior. https://docs.python.org/3.9/library/venv.html#venv.EnvBuilder.ensure_direct… The last sentence for ensure_directories(env_dir) reads: The directories are allowed to exist already, as long as either clear or upgrade were specified to allow operating on an existing environment directory. After testing and looking at the code (including past commits back over 6 years), this is not true. ensure_directories completely disregards the `upgrade` attribute. Also it allows directories to exist already unconditionally (always operating without error), whether the `clear` attribute is set or not. In addition, if `clear` is not set, it doesn't make any changes to the directories, but helpfully still returns the context of venv paths. Ref: https://github.com/python/cpython/blob/3ce35bfbbe29664942f9a8c50c177a4575a3… ---------- assignee: docs@python components: Documentation messages: 395603 nosy: docs@python, itsayellow priority: normal severity: normal status: open title: venv API Docs for EnvBuilder.ensure_directories incorrectly describe behavior versions: Python 3.10, Python 3.11, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44388> _______________________________________

4 5

[issue43184] Missing docs for LoggerAdapter manager and name property
by Vinay Sajip July 28, 2021

July 28, 2021

Change by Vinay Sajip <vinay_sajip(a)yahoo.co.uk>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43184> _______________________________________

1 0

[issue44399] log rotator cookbook example might waste disk space
by mori-b July 28, 2021

July 28, 2021

New submission from mori-b <moribirom(a)gmail.com>: In https://docs.python.org/3/howto/logging-cookbook.html#using-a-rotator-and-n…, the log rotator example deletes the original log file after compressing it. However, running on Linux the command "lsof +S1" shows that the deleted original log file might still hold the same disk space, and keep growing. Replacing the command "os.remove(source)" with "os.truncate(source,0)" seems to solve the issue by freeing the original log file disk space at each rotation. ---------- assignee: docs@python components: Documentation messages: 395658 nosy: docs@python, mori-b priority: normal severity: normal status: open title: log rotator cookbook example might waste disk space type: resource usage _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44399> _______________________________________

4 16