Mailman 3 April 2022 - Docs-bugs

[issue459007] Document sys.path on Windows
by admin 10 Apr '22

10 Apr '22

Change by admin <roundup-admin(a)psf.upfronthosting.co.za>: ---------- github: None -> 35125 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue459007> _______________________________________

1 0

[issue5901] missing meta-info in documentation pdf
by Ned Deily 08 Apr '22

08 Apr '22

Ned Deily <nad(a)python.org> added the comment: The problem seems to have been fixed again somewhere in the past. ---------- nosy: +ned.deily resolution: -> fixed stage: patch review -> resolved status: open -> closed versions: +Python 3.10, Python 3.11, Python 3.9 -Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue5901> _______________________________________

1 0

[issue35962] [doc] Slight error in words in [ 2.4.1. String and Bytes literals ]
by Irit Katriel 08 Apr '22

08 Apr '22

Change by Irit Katriel <iritkatriel(a)gmail.com>: ---------- keywords: +easy priority: normal -> low title: Slight error in words in [ 2.4.1. String and Bytes literals ] -> [doc] Slight error in words in [ 2.4.1. String and Bytes literals ] versions: +Python 3.10, Python 3.11, Python 3.9 -Python 2.7, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35962> _______________________________________

1 0

[issue44213] LIST_TO_TUPLE placed below the sentence "all of the following use their opcodes" in dis library documentaiton.
by glubs9 08 Apr '22

08 Apr '22

New submission from glubs9 <jonte.fry(a)gmail.com>: in the dis library documentation where it lists all of the instructions in python bytecode, it includes a small sentence about half way dow "all of the following instructions use their arguments". After this sentence there is an instruction specified LIST_TO_TUPLE which does not in fact use its argument. It's a minor mistake but 100% on how it should be fixed so I have not yet made a pr. It could be fixed by removing the sentence or just moving it above the sentence. I'm not sure. ---------- assignee: docs@python components: Documentation messages: 394178 nosy: docs@python, glubs9 priority: normal severity: normal status: open title: LIST_TO_TUPLE placed below the sentence "all of the following use their opcodes" in dis library documentaiton. type: enhancement versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44213> _______________________________________

3 4

[issue47255] Many broken :meth: roles in the docs
by Jelle Zijlstra 08 Apr '22

08 Apr '22

New submission from Jelle Zijlstra <jelle.zijlstra(a)gmail.com>: The docs for the hash() builtin use :meth:`__hash__`, but this doesn't actually link to the datamodel documentation for __hash__: it needs :meth:`~object.__hash__` instead. I'm fixing this in the builtin functions docs, but there are probably more places. Why don't we warn when a :meth: link doesn't actually create a link? ---------- assignee: docs@python components: Documentation messages: 416956 nosy: JelleZijlstra, docs@python priority: normal severity: normal status: open title: Many broken :meth: roles in the docs versions: Python 3.10, Python 3.11, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47255> _______________________________________

2 3

[issue47261] RFC: Clarify usage of macros for PySequence_Fast within the Limited C API
by Rohit Goswami 08 Apr '22

08 Apr '22

Change by Rohit Goswami <rog32(a)hi.is>: ---------- title: RFC: Clarify Limited API macros for PySequence_Fast -> RFC: Clarify usage of macros for PySequence_Fast within the Limited C API _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47261> _______________________________________

1 0

[issue47261] RFC: Clarify Limited API macros for PySequence_Fast
by Rohit Goswami 08 Apr '22

08 Apr '22

Rohit Goswami <rog32(a)hi.is> added the comment: Perhaps to be clear, there are two possibilities: 1. `PySequence_Fast` should be removed from the Limited API 2. All macros used with `PySequence_Fast` are valid for use in the context of the Limited API In either case the documentation should need to be clarified. The only situation where no changes would result is if: - `PySequence_Fast` is part of the Limited API, but must be treated the same as a regular `PySequence` object + Since only `PySequence_Size` and other variants can be used in the context of the Limited API This is actually also still confusing and should be mentioned clearly. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47261> _______________________________________

1 0

[issue47261] RFC: Clarify Limited API macros for PySequence_Fast
by Rohit Goswami 08 Apr '22

08 Apr '22

Change by Rohit Goswami <rog32(a)hi.is>: ---------- assignee: -> docs@python components: +C API, Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue47261> _______________________________________

1 0

[issue47138] Bump Sphinx to fix docs build
by Hugo van Kemenade 08 Apr '22

08 Apr '22

New submission from Hugo van Kemenade <hugovk+python(a)gmail.com>: The docs build on GitHub Actions is passing on `main` but has started failing for the `3.7` - `3.10` branches: ``` Missing the required blurb or sphinx-build tools. Please run 'make venv' to install local copies. make[1]: *** [Makefile:50: build] Error 1 ``` https://github.com/python/cpython/actions/workflows/doc.yml https://github.com/python/cpython/runs/5714593700?check_suite_focus=true This is because the `PATH=./venv/bin:$PATH sphinx-build --version` check is failing: ``` /home/runner/work/cpython/cpython/Doc/venv/lib/python3.10/site-packages/sphinx/util/docutils.py:45: DeprecationWarning: distutils Version classes are deprecated. Use packaging.version instead. __version_info__ = tuple(LooseVersion(docutils.__version__).version) Traceback (most recent call last): File "/home/runner/work/cpython/cpython/Doc/./venv/bin/sphinx-build", line 5, in <module> from sphinx.cmd.build import main File "/home/runner/work/cpython/cpython/Doc/venv/lib/python3.10/site-packages/sphinx/cmd/build.py", line 25, in <module> from sphinx.application import Sphinx File "/home/runner/work/cpython/cpython/Doc/venv/lib/python3.10/site-packages/sphinx/application.py", line 42, in <module> from sphinx.registry import SphinxComponentRegistry File "/home/runner/work/cpython/cpython/Doc/venv/lib/python3.10/site-packages/sphinx/registry.py", line 24, in <module> from sphinx.builders import Builder File "/home/runner/work/cpython/cpython/Doc/venv/lib/python3.10/site-packages/sphinx/builders/__init__.py", line 26, in <module> from sphinx.util import import_object, logging, rst, progress_message, status_iterator File "/home/runner/work/cpython/cpython/Doc/venv/lib/python3.10/site-packages/sphinx/util/rst.py", line 22, in <module> from jinja2 import environmentfilter ImportError: cannot import name 'environmentfilter' from 'jinja2' (/home/runner/work/cpython/cpython/Doc/venv/lib/python3.10/site-packages/jinja2/__init__.py) ``` This is because `3.10` and `3.9` are still using old versions of Sphinx (3.2.1 and 2.4.4 respectively) which is incompatible with the newest Jinja2: https://github.com/pallets/jinja/issues/1630 `main` is using a newer Sphinx (4.2.0), so it passes. Bumping to Sphinx 4.5.0 will fix both `3.9` and `3.10`. `3.7` and `3.8` are affected too. We can bump `main` to use `4.5.0` as well. ---------- assignee: docs@python components: Documentation messages: 416149 nosy: docs@python, hugovk priority: normal severity: normal status: open title: Bump Sphinx to fix docs build 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/issue47138> _______________________________________

6 24

[issue23312] google thinks the docs are mobile unfriendly
by Petr Viktorin 08 Apr '22

08 Apr '22

Change by Petr Viktorin <encukou(a)gmail.com>: ---------- resolution: -> fixed stage: needs patch -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue23312> _______________________________________

1 0