docs

docs@python.org

1 participants
14888 discussions

[issue40064] py38: document xml.etree.cElementTree will be removed in 3.9

by Chitrank-Dixit

New submission from Chitrank-Dixit <chitrankdixit(a)gmail.com>: Looking at this issue, I can see the changes in the file `xml.etree.elementtree` should go like .. warning:: The :mod:`xml.etree.ElementTree` will be removed from python 3.9. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40064> _______________________________________

1 hour, 40 minutes

[issue40064] py38: document xml.etree.cElementTree will be removed in 3.9

by Chitrank-Dixit

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 hour, 44 minutes

[issue41507] Use utf-8 in "Reading and Writing Files" tutorial.

by Inada Naoki

New submission from Inada Naoki <songofacandy(a)gmail.com>: https://docs.python.org/3/tutorial/inputoutput.html#reading-and-writing-fil… Current tutorial doesn't mention about encoding and example uses locale encoding. Since UTF-8 is major text encoding and many Windows environment doesn't use UTF-8 by default, encoding should be mentioned in the tutorial and UTF-8 should be recommended. Additionally, the paragraph about line ending conversion [1] can be removed. This was important in Python 2. But it is not important because (en|de)coding binary data is nonsense already. [1]: "This behind-the-scenes modification to file data is fine for text files, but will corrupt binary data like that in JPEG or EXE files. Be very careful to use binary mode when reading and writing such files." ---------- assignee: docs@python components: Documentation keywords: newcomer friendly messages: 375033 nosy: docs@python, inada.naoki priority: normal severity: normal status: open title: Use utf-8 in "Reading and Writing Files" tutorial. type: enhancement versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41507> _______________________________________

4 hours, 41 minutes

[issue41455] Python Devguide differs from python docs

by Yaroslac

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> _______________________________________

8 hours, 38 minutes

[issue41504] Add links to asttokens, leoAst, LibCST and Parso to ast.rst

by Edward K Ream

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> _______________________________________

10 hours, 28 minutes

[issue41460] Translation Error in in Functional Programming HOWTO page

by Terry J. Reedy

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: This tracker is only for the original English version of the docs. The translations are by a different group with different tools and workflow. This page https://docs.python.org/ja/3/bugs.html# should not literally translate the instructions for the English version. Julien, I thought there was something about translations in the devguide but cannot find it. https://devguide.python.org/docquality/ would seen line a good place. ---------- nosy: +terry.reedy resolution: -> third party stage: -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41460> _______________________________________

12 hours, 45 minutes

[issue40051] Dead link in help(lib2to3)

by wyz23x2

New submission from wyz23x2 <wyz23x2(a)163.com>: When typing this in shell: >>> import lib2to3 >>> help(lib2to3) The output contains this link: --snip-- MODULE REFERENCE https://docs.python.org/3.8/library/lib2to3 <-- The following documentation is automatically generated from the Python --snip-- But when you access it, 404! This works: https://docs.python.org/3.8/library/2to3.html#module-lib2to3 Please change it. Thanks! ---------- assignee: docs@python components: 2to3 (2.x to 3.x conversion tool), Documentation, Library (Lib) messages: 364917 nosy: docs@python, wyz23x2 priority: normal severity: normal status: open title: Dead link in help(lib2to3) type: performance versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40051> _______________________________________

17 hours, 16 minutes

[issue41411] Improve and consolidate f-strings docs

by Ezio Melotti

New submission from Ezio Melotti <ezio.melotti(a)gmail.com>: [Creating a new issue from #41045] I was just just trying to link to someone the documentation for f-strings, but: 1) Searching "fstring" only returns two results about xdrlib[0]; 2) Searching "f-string" returns many unrelated results[1]; 3) The first (and closer) result (string -- Common string operations[2]) yields nothing while using ctrl+f with fstring, f-string, f', f"; 4) at the top of that page there are two links in a "see also": * Text Sequence Type — str[3]: it mentions raw strings at the beginning, but also yields no results for fstring, f-string, f', f"; * String Methods[4]: that is another section of the previous page (so ctrl+f doesn't find anything), but has a link to "Format String Syntax"[5]; 5) The "Format String Syntax" page[5] has another link in the middle of a paragraph that points to "formatted string literals", that eventually brings us to the right page[6]; 6) the "right page"[6] has a wall of text with a block of code containing the grammar, luckily followed by a few examples. I think we should: 1) add index entries for "f-string" and "fstring" in the relevant sections of the docs, so that they appear in the search result; 2) in the Text Sequence Type — str[3] section, have a bullet list for f-strings, raw-strings, and possibly u-strings; 3) possibly use the term "f-string" in addition (or instead) of "formatted string literal", to make the pages more ctrl+f-friendly throughout the docs; 4) possibly have another more newbie-friendly section on f-string (compared to the lexical analysis page) in the tutorial, in the stdtypes page[7] (e.g. before the printf-style String Formatting" section[8]), or in the string page[2] (e.g. after the "Format String Syntax" section[10]); 5) possibly reorganize and consolidate the different sections about strings, string methods, str.format(), the format mini-language, f-strings, raw/unicode-strings, %-style formatting in a single page or two (a page for the docs and one for the grammar), since it seems to me that over the years these sections got a bit scattered around as they were being added. [0]: https://docs.python.org/3/search.html?q=fstring [1]: https://docs.python.org/3/search.html?q=f-string [2]: https://docs.python.org/3/library/string.html [3]: https://docs.python.org/3/library/stdtypes.html#textseq [4]: https://docs.python.org/3/library/stdtypes.html#string-methods [5]: https://docs.python.org/3/library/string.html#formatstrings [6]: https://docs.python.org/3/reference/lexical_analysis.html#f-strings [7]: https://docs.python.org/3/library/stdtypes.html [8]: https://docs.python.org/3/library/stdtypes.html#printf-style-string-formatt… ---------- assignee: docs@python components: Documentation messages: 374398 nosy: docs@python, eric.smith, ezio.melotti priority: normal severity: normal stage: needs patch status: open title: Improve and consolidate f-strings docs type: enhancement versions: Python 3.10, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41411> _______________________________________

2 days, 3 hours

[issue41450] OSError is not documented in ssl library, but still can be thrown

by Alexander Sibiryakov

New submission from Alexander Sibiryakov <sixty-one(a)yandex.ru>: See stack trace [07/15/2020 08:51:14.799: ERROR/kafka.producer.sender] Uncaught error in kafka producer I/O thread Traceback (most recent call last): File "/usr/local/lib/python3.6/site-packages/kafka/producer/sender.py", line 60, in run self.run_once() File "/usr/local/lib/python3.6/site-packages/kafka/producer/sender.py", line 160, in run_once self._client.poll(timeout_ms=poll_timeout_ms) File "/usr/local/lib/python3.6/site-packages/kafka/client_async.py", line 580, in poll self._maybe_connect(node_id) File "/usr/local/lib/python3.6/site-packages/kafka/client_async.py", line 390, in _maybe_connect conn.connect() File "/usr/local/lib/python3.6/site-packages/kafka/conn.py", line 426, in connect if self._try_handshake(): File "/usr/local/lib/python3.6/site-packages/kafka/conn.py", line 505, in _try_handshake self._sock.do_handshake() File "/usr/local/lib/python3.6/ssl.py", line 1077, in do_handshake self._sslobj.do_handshake() File "/usr/local/lib/python3.6/ssl.py", line 689, in do_handshake self._sslobj.do_handshake() OSError: [Errno 0] Error See docs https://docs.python.org/3.8/library/ssl.html and see source code: https://github.com/python/cpython/blob/3.8/Modules/_ssl.c Probably the best would be to proceed with using SSLError, but short term OSError could be documented. ---------- assignee: docs@python components: Documentation messages: 374644 nosy: docs@python, sibiryakov priority: normal severity: normal status: open title: OSError is not documented in ssl library, but still can be thrown type: behavior versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue41450> _______________________________________

2 days, 7 hours

[issue41482] docstring errors in ipaddress.IPv4Network

by Eric Frederich

New submission from Eric Frederich <eric.frederich(a)gmail.com>: The __init__ method for IPv4Network has a typo where it says all three of '192.0.2.0/24', '192.0.2.0/255.255.255.0' and '192.0.0.2/0.0.0.255' should be equal. ---------- assignee: docs@python components: Documentation messages: 374841 nosy: docs@python, eric.frederich priority: normal severity: normal status: open title: docstring errors in ipaddress.IPv4Network type: enhancement 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/issue41482> _______________________________________

2 days, 9 hours

Jump to page:

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

docs