Mailman 3 August 2020 - docs

Possible python documentation bug?
by Doug Nintzel Aug. 13, 2020

Aug. 13, 2020

Hello,I would be happy to submit a bug report, but not sure this is just a misunderstanding on my part. Here is the details of the possible issue?Documentation: email.message.Message: Representing an email message using the compat32 API — Python 3.8.5 documentation | | | | email.message.Message: Representing an email message using the compat32 ... | | | SECTION: "An email message consists of headers and a payload. Headers must be RFC 5233 style names and values, where the field name and value are separated by a colon. The colon is not part of either the field name or the field value. The payload may be a simple text message, or a binary object, or a structured sequence of sub-messages each with their own set of headers and their own payload. The latter type of payload is indicated by the message having a MIME type such as multipart/* or message/rfc822." Concern:I think this intends to refer to RFC 5322 not RFC 5233, Correct? See correct example in this documentation referencing RFC 5322. Regards,Doug | | | | email.message: Representing an email message — Python 3.8.5 documentation | | | Regards,Doug

1 0

[issue41066] Update documentation for Pathlib
by Srinivas Reddy Thatiparthy(శ్రీన ివాస్ రెడ్డి తాట ిపర్తి) Aug. 13, 2020

Aug. 13, 2020

New submission from Srinivas Reddy Thatiparthy(శ్రీనివాస్ రెడ్డి తాటిపర్తి) <thatiparthysreenivas(a)gmail.com>: The correspondence section between os, os.path vs pathlib is missing two entries. https://docs.python.org/3/library/pathlib.html#correspondence-to-tools-in-t… 1. os.link vs path.link_to 2. os.path.listdir vs path.iterdir I think adding them would be a good addition. ---------- assignee: docs@python components: Documentation messages: 372001 nosy: docs@python, thatiparthy priority: normal severity: normal status: open title: Update documentation for Pathlib 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/issue41066> _______________________________________

4 9

[issue33479] Document tkinter and threads
by Richard Sheridan Aug. 13, 2020

Aug. 13, 2020

Change by Richard Sheridan <richard.sheridan(a)gmail.com>: ---------- nosy: +Richard Sheridan _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33479> _______________________________________

1 0

[issue40979] typing module docs: keep text, add subsections
by ramalho Aug. 12, 2020

Aug. 12, 2020

New submission from ramalho <luciano(a)ramalho.org>: The typing module documentation page has a very long section "Classes, functions, and decorators" (https://docs.python.org/3/library/typing.html#classes-functions-and-decorat…) that should be split in subsections. The ordering of the entries seems haphazard: it's not alphabetical. Its grouped according to invisible categories. The categories appear as comments in the source code of typing.py: the `__all__` global lists the API split into categories (see below). We should add these categories to the page as subsections of "Classes, functions, and decorators" - Super-special typing primitives. - ABCs (from collections.abc). - Structural checks, a.k.a. protocols. - Concrete collection types. ---------- assignee: docs@python components: Documentation messages: 371514 nosy: docs@python, ramalho priority: normal severity: normal status: open title: typing module docs: keep text, add subsections versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40979> _______________________________________

6 13

[issue41455] Python Devguide differs from python docs
by Yaroslac Aug. 12, 2020

Aug. 12, 2020

New submission from Yaroslac <flower.moor(a)gmail.com>: As I can see here https://github.com/python/devguide/blob/master/garbage_collector.rst#collec… > the GC only triggers a full collection of the oldest generation if the ratio long_lived_pending / long_lived_total is above a given value (hardwired to 25%) But in the python docs here https://docs.python.org/3.10/library/gc.html#gc.set_threshold > When the number of allocations minus the number of deallocations exceeds threshold0, collection starts. Initially only generation 0 is examined. If generation 0 has been examined more than threshold1 times since generation 1 has been examined, then generation 1 is examined as well. Similarly, threshold2 controls the number of collections of generation 1 before collecting generation 2. So, which one is correct? ---------- assignee: docs@python components: Documentation messages: 374665 nosy: Yaroslav, docs@python priority: normal severity: normal status: open title: Python Devguide differs from python docs type: resource usage versions: Python 3.10, Python 3.5, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41455> _______________________________________

7 13

[issue41475] Fix mistake in "What's new in Python 3.7"
by Ram Rachum Aug. 12, 2020

Aug. 12, 2020

New submission from Ram Rachum <ram(a)rachum.com>: Writing the patch now. ---------- assignee: docs@python components: Documentation messages: 374814 nosy: cool-RR, docs@python priority: normal severity: normal status: open title: Fix mistake in "What's new in Python 3.7" versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41475> _______________________________________

7 16

[issue41504] Add links to asttokens, leoAst, LibCST and Parso to ast.rst
by Edward K Ream Aug. 11, 2020

Aug. 11, 2020

New submission from Edward K Ream <edreamleo(a)gmail.com>: These links added with the provisional approval of GvR, pending approval of the PR. ---------- assignee: docs@python components: Documentation messages: 375019 nosy: docs@python, edreamleo priority: normal severity: normal status: open title: Add links to asttokens, leoAst, LibCST and Parso to ast.rst type: enhancement versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41504> _______________________________________

4 9

[issue36700] base64 has old references that should be updated
by Paul Hoffman Aug. 10, 2020

Aug. 10, 2020

New submission from Paul Hoffman <phoffman(a)proper.com>: The documentation for base64 library has an RFC that is obsolete. ---------- assignee: docs@python components: Documentation messages: 340668 nosy: docs@python, paulehoffman priority: normal pull_requests: 12839 severity: normal status: open title: base64 has old references that should be updated _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue36700> _______________________________________

3 4

Documentation bug in itertools.combinations
by Christopher Jones Aug. 8, 2020

Aug. 8, 2020

It looks like the indentation is off here <https://docs.python.org/3/library/itertools.html#itertools.combinations> for the "roughly equivalent to" code for itertools.combinations. Currently, i is out of scope after the "else". Best wishes, Chris

1 0

[issue40064] py38: document xml.etree.cElementTree will be removed in 3.9
by Chitrank-Dixit Aug. 8, 2020

Aug. 8, 2020

Change by Chitrank-Dixit <chitrankdixit(a)gmail.com>: ---------- keywords: +patch nosy: +Chitrank-Dixit nosy_count: 2.0 -> 3.0 pull_requests: +20925 stage: -> patch review pull_request: https://github.com/python/cpython/pull/21784 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40064> _______________________________________

1 0