Mailman 3 July 2020 - docs

Super() documentation
by Mark Ballard 09 Jul '20

09 Jul '20

Dear Python Docs folk Would you please consider making a clarification in part of the documentation for the super() builtin <https://docs.python.org/3/library/functions.html#super>. It's first example says (in brief): where super() is a method thus: super([type[, object-or-type]]) then given a type : B and given an object-or-type with __mro__ : D -> B -> C -> A -> object "super() searches C -> A -> object" It does mean, does it not, that super( B, object-or-type ) searches C -> A -> object? It seems pretty obvious. But it does help if these things are spelt out for those without enough prior knowledge or experience to draw the obvious conclusions. Similarly, it would help to say that the example mro (D -> B -> C -> A -> object) refers finally to the builtin Python base class object. Thank you Mark Ballard

2 1

[issue41199] Docstring convention not followed for dataclasses documentation page
by Jackstraw 09 Jul '20

09 Jul '20

New submission from Jackstraw <jab1995(a)gmail.com>: The InventoryItem class on the dataclasses page [https://docs.python.org/3.7/library/dataclasses.html#module-dataclasses] has single quotes for the docstring, as opposed to double quotes (as described by PEP-257. ---------- assignee: docs@python components: Documentation messages: 372899 nosy: JackStraw, docs@python priority: normal severity: normal status: open title: Docstring convention not followed for dataclasses documentation page type: enhancement versions: Python 3.10, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41199> _______________________________________

8 15

[issue41248] Python manual forced in maximized window
by Mischiew Rithe 08 Jul '20

08 Jul '20

New submission from Mischiew Rithe <mischiew(a)gmail.com>: In versions 3.8.1 and 3.8.3-amd64 (only versions tested), on Windows, the "Python 3.8 Manuals" opens in a maximized window. This is unexpected and undesired, as the user cannot see the other windows, including the one he's developing from (IDE, editor, shell, ...). The problem seems to come from the shortcut created in the menu, which forces a maximized window. It has to be set to "normal window" instead. ---------- assignee: docs@python components: Documentation messages: 373335 nosy: Mischiew Rithe, docs@python priority: normal severity: normal status: open title: Python manual forced in maximized window type: behavior versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41248> _______________________________________

1 0

[issue41245] cmath module documentation is misleading on branch cuts
by Mark Dickinson 08 Jul '20

08 Jul '20

Mark Dickinson <dickinsm(a)gmail.com> added the comment: > [...] see the change of sign in the real part below [...] Grr. Stupid fingers. That should say "imaginary part", not "real part" ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41245> _______________________________________

1 0

[issue41245] cmath module documentation is misleading on branch cuts
by Mark Dickinson 08 Jul '20

08 Jul '20

Mark Dickinson <dickinsm(a)gmail.com> added the comment: Yes, that looks like the right part of the sqrt code. For the acos docstring, "continuous from below" implies that for any complex number z that lies exactly _on_ the branch cut, acos(z) is close to acos(w) for a nearby value w just _below_ the branch cut. But that's demonstrably not true: see the change of sign in the real part below: >>> acos(complex(2.3, -1e-10)) # value just "below" the branch cut (4.828045495852677e-11+1.475044781241425j) >>> acos(complex(2.3, 0.0)) # nearby value exactly _on_ the branch cut -1.475044781241425j In effect, for a branch cut along the real axis, the sign of the zero in the imaginary part of the argument allows us to be continuous from both sides at once. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41245> _______________________________________

1 0

[issue41245] cmath module documentation is misleading on branch cuts
by Raymond Hettinger 08 Jul '20

08 Jul '20

Raymond Hettinger <raymond.hettinger(a)gmail.com> added the comment: +1 for changing the language to match the actual mechanics. > "the sign of the imaginary part of x is used [...]" I'm trying to see where this happens. Is this part of cmath_sqrt? if (z.real >= 0.) { r.real = s; r.imag = copysign(d, z.imag); } else { r.real = d; r.imag = copysign(s, z.imag); } > "continuous from below" and "continuous from above" > language is misleading; I'm curious, is that language incorrect? My mental image of a branch cut is a helical graph with the edge cases being continuous from above and below. Likewise, my mental model for branch cut logic is it resolves multiple possible output values in a way preserves continuity from one side or the other. In other words, I think about branch cuts in terms of continuity rather than sign preservation. Is that incorrect? ---------- nosy: +rhettinger _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41245> _______________________________________

1 0

[issue41245] cmath module documentation is misleading on branch cuts
by Mark Dickinson 08 Jul '20

08 Jul '20

Change by Mark Dickinson <dickinsm(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python versions: +Python 3.10, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41245> _______________________________________

1 0

[issue39417] Link to "Python Packaging User Guide: Creating and using virtual environments" is broken
by Angel Cervera Claudio 07 Jul '20

07 Jul '20

New submission from Angel Cervera Claudio <angelcervera(a)silyan.com>: The link "See also: Python Packaging User Guide: Creating and using virtual environments" Is broken. The problem is in line 30 of https://github.com/python/cpython/blob/3.8/Doc/library/venv.rst I don't know the right link, so I can not fix it. I any one provive me the right link, I can create a PR. ---------- assignee: docs@python components: Documentation messages: 360454 nosy: angelcervera, docs@python priority: normal severity: normal status: open title: Link to "Python Packaging User Guide: Creating and using virtual environments" is broken versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39417> _______________________________________

8 12

[issue41228] Fix the typo in the description of calendar.monthcalendar(year, month)
by Nima Dini 07 Jul '20

07 Jul '20

Change by Nima Dini <nima.dini(a)gmail.com>: ---------- assignee: docs@python components: Documentation nosy: docs@python, ndini priority: normal pull_requests: 20516 severity: normal status: open title: Fix the typo in the description of calendar.monthcalendar(year, month) type: enhancement versions: Python 3.10 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41228> _______________________________________

1 0

[issue40742] Doc: Parallel build break audit table
by Julien Palard 06 Jul '20

06 Jul '20

New submission from Julien Palard <julien+python(a)palard.fr>: Currently we can't build the doc using sphinx parallel builds, like: `sphinx-build -j auto`, because the audit-events table [1] is not generated in this case. [1]: https://docs.python.org/3/library/audit_events.html To reproduce: make -C Doc SPHINXOPTS='-j auto' autobuild-dev-html see build/html/library/audit_events.html see also: https://mail.python.org/archives/list/python-dev@python.org/thread/POWT35UL… ---------- assignee: docs@python components: Documentation messages: 369712 nosy: docs@python, mdk, xtreak priority: normal severity: normal status: open title: Doc: Parallel build break audit table versions: Python 3.10, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40742> _______________________________________

1 3