Mailman 3 May 2024 - docs

Typo in Python documentation
by Kass, Michael [US-US] 31 May '24

31 May '24

https://docs.python.org/3/library/contextlib.html I've got it set to English, 3.12.3. The "up" after "cleanup" should be deleted. ExitStack<https://docs.python.org/3/library/contextlib.html#contextlib.ExitStack> makes it possible to instead register a callback for execution at the end of a with statement, and then later decide to skip executing that callback: from contextlib import ExitStack with ExitStack() as stack: stack.callback(cleanup_resources) result = perform_operation() if result: stack.pop_all() This allows the intended cleanup up behaviour to be made explicit up front, rather than requiring a separate flag variable. Michael L. Kass | Leidos Sr Software Developer Transportation Solutions (ERAM Software) michael.kass(a)leidos.com<mailto:michael.kass@leidos.com> | www.leidos.com +1 (301) 240-5734 O

2 1

Python docs download page is out of date
by Thomas Schneider 28 May '24

28 May '24

Hi there, https://python.readthedocs.io/en/latest/download.html > Last updated on: Nov 15, 2017. Every link is broken as well. Would probably be nice to link to https://www.python.org/ftp/python/doc/3.9.9/ docs. Have a nice day Thomas

2 1

HTML docs
by Octavio Bustos 24 May '24

24 May '24

Hello, I see that the HTML files are able to be downloaded as a zip. How exactly can these be opened on your local machine? Would I need to host these docs on a server to view them? I have the pandas docs downloaded butt when i try to host them the search button does not work.

1 0

A suggestion for improving the documentation of chapter 10.9. Data Compression
by Guy Goldner 22 May '24

22 May '24

Hello dear Python gods :) I'm new at Python and was going over the documentation . This useful paragraph : https://docs.python.org/3.7/tutorial/stdlib.html#data-compression provides info for compressing text but IMHO some important additional info is needed, without which I expect nearly all users would get stuck just as I have. Moreover, while looking for a solution I noticed a lot of articles with outdated examples which no longer work - this confused me even more to the point I started suspecting something was amiss on my end... Anyhow, adding this info would do the trick : zlib works only with bytes and in Python 3.x strings are no longer bytes. Example : *>>> zlib.compress('this is a sample string which does not work in zlib because it requires bytes and not unicode')Traceback (most recent call last): File "<stdin>", line 1, in <module>TypeError: a bytes-like object is required, not 'str'>>>* Luckily Python has a very simple solution for this : encode to utf-8, compress, decode back to unicode like so : *>>> text = 'this is a sample string which does not work in zlib because it requires bytes and not unicode with chars like this »שלום '>>> encoded = text.encode()>>> text = 'this is a sample with unicode chars »שלום '>>> encoded = text.encode()>>> compressed = zlib.compress(encoded)>>> decompressed = zlib.decompress(compressed)>>> decoded = decompressed.decode()>>> len(text),len(encoded),len(compressed) #notice that compression of short strings can be larger than the original(42, 47, 54)>>> print(text,'\n',encoded,'\n',compressed)this is a sample with unicode chars »שלום b'this is a sample with unicode chars \xc2\xbb\xd7\xa9\xd7\x9c\xd7\x95\xd7\x9d ' b'x\x9c+\xc9\xc8,V\x00\xa2D\x85\xe2\xc4\xdc\x82\x9cT\x85\xf2\xcc\x92\x0c\x85\xd2\xbc\xcc\xe4\xfc\x94T\x85\xe4\x8c\xc4\xa2b\x85C\xbb\xaf\xaf\xbc>\xe7\xfa\xd4\xebs\x15\x00\xb2K\x14|'>>> text == decodedTrue* Thank you ! You are doing a great thing ! B.R., Guy Goldner

2 2

[fatal error]Download — Python 3.12.3 documentation
by Bilal Shirazi 07 May '24

07 May '24

Hello Python team, I’ve tried a few times however the ePub documentation download link shows this error when opening the ePub in the native MAC Books application Darwin Bilals-Mac-mini.local 23.4.0 Darwin Kernel Version 23.4.0: Fri Mar 15 00:19:22 PDT 2024; root:xnu-10063.101.17~1/RELEASE_ARM64_T8112 arm64 And Books : Version 6.3 (6040) “error on line 80 at column 12: error parsing attribute name” Excerpt From Python Python Documentation Authors This material may be protected by copyright. > https://docs.python.org/3.12/download.html

3 2

Documentation typo
by Andrew DaGeek 01 May '24

01 May '24

Greetings, At the end of https://docs.python.org/3/using/windows.html#launcher and right before https://docs.python.org/3/using/windows.html#launcher It should be: The Tag is matched *on either* the full string, or a prefix, provided the next character is a dot or a hyphen. Is it possible to contribute to the documentation through github? I'm still learning Python. Thank you for your attention. https://github.com/mz3r0

1 0