Mailman 3 May 2020 - docs

[issue2716] Document license under which audioop is used
by Furkan Onder 07 May '20

07 May '20

Furkan Onder <furkanonder(a)protonmail.com> added the comment: PR has been sent. ---------- nosy: +furkanonder _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue2716> _______________________________________

1 0

[issue40537] Typo in Doc/library/sqlite3.rst
by Joannah Nanjekye 06 May '20

06 May '20

New submission from Joannah Nanjekye <nanjekyejoannah(a)gmail.com>: >From this: Now you want to store the point in a single SQLite column. First you'll have to choose one of the supported types first to be used for representing the point. First looks repeated. ---------- assignee: docs@python components: Documentation messages: 368295 nosy: docs@python, nanjekyejoannah priority: normal severity: normal status: open title: Typo in Doc/library/sqlite3.rst versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40537> _______________________________________

2 2

asyncio "bug"
by Chris Drake 06 May '20

06 May '20

Hi, The sample on this page is not demonstrating anything asynchronous: https://docs.python.org/3/library/asyncio.html Please make it into an example that actually makes sense in the context of the topic. For example - do something asynchronous (sleep 5 secs) while demonstrating that it is (e.g. make something else count to 10 in 1-second steps - so we can see what's going on). Also - the "Hello World" heading suggests it is script output, but it is not. Good idea to fix everything and be clear. Kind Regards, Chris Drake.

2 2

Obj: Informations about Python courses/ theoretical material
by Veronica Delsoglio 06 May '20

06 May '20

Dears, My name is Veronica, I am a Ph.D student and I am working on a project which includes the use of Python. My programming experience is at the beginning, and, although my role is focused on the usage of a software interfaced to python (Pyrosetta) and not on Python at all, I want to improve a bit more my skills and knowledge on it. I am writing to you because I have found online a PDF Python tutorial, and I have found your email on there. I just want to ask you if you are also organising some "lectures" or online courses (I saw that you are a Python development team), or if you suggest to complete entirely the pdf guide in order to reach a basic level of knowledge. So, I am just asking for informations on how reaching a complete basic level, if you can help me somehow. Thank you for your attention, Waiting for your reply, All the best, Regards Veronica delsoglio

2 1

python doc :: configparser example file write requires minor change
by SharatKumar 05 May '20

05 May '20

*URL : *https://docs.python.org/3/library/configparser.html *Current documentation states:* >>> with open('example.ini', 'w') as *configfile*: ... config.write(*configfile*) *I think it should be *>>> with open('example.ini', 'w') as *configfile*: ... *configfile*.write(*config*)

1 1

[issue40499] asyncio.wait documentation on non-emptiness requirement lost in bpo-33649
by Joel Rosdahl 04 May '20

04 May '20

New submission from Joel Rosdahl <joel.rosdahl(a)gmail.com>: bpo-21596 documented that the sequence of futures passed to asyncio.wait must not be empty: The sequence *futures* must not be empty. This note was however lost in the bpo-33649 commit (3faaa8857a42a36383bb18425444e597fc876797). ---------- assignee: docs@python components: Documentation messages: 368041 nosy: Joel Rosdahl, docs@python priority: normal severity: normal status: open title: asyncio.wait documentation on non-emptiness requirement lost in bpo-33649 versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40499> _______________________________________

2 3

[issue21596] asyncio.wait fails when futures list is empty
by Sebastian Kreft 04 May '20

04 May '20

New submission from Sebastian Kreft: Passing an empty list/set of futures to asyncio.wait raises an Exception, which is a little annoying in some use cases. Probably this was the intended behavior as I see there's a test case for that. If such, then I would propose to document that behavior. ---------- assignee: docs@python components: Documentation messages: 219290 nosy: Sebastian.Kreft.Deezer, docs@python priority: normal severity: normal status: open title: asyncio.wait fails when futures list is empty versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue21596> _______________________________________

5 9

[issue33649] asyncio docs overhaul
by Yury Selivanov 04 May '20

04 May '20

New submission from Yury Selivanov <yselivanov(a)gmail.com>: An overhaul of asyncio documentation is long overdue. Here's the structure for it that I have in mind: - Introduction (what is asyncio and async/await) - A quick tutorial (show how to use asyncio.run() and basic functions like asyncio.sleep() and teach that asyncio programs are all about async/await and *not* about callbacks or event loops) - High-level APIs (Tasks, Streams, Subprocesses, few other functions) - Low-level APIs - Preface (talk a bit about everything: what's an event loop, what is a Future and a Transport) - Futures - Event loop APIs - Transports and Protocols (when to use and when not to use them) - Tutorials - High-level networking server - HTTP application - Low-level protocol implementation using Transports - etc ---------- assignee: docs@python components: Documentation, asyncio messages: 317709 nosy: akuchling, asvetlov, docs@python, yselivanov priority: normal severity: normal status: open title: asyncio docs overhaul type: enhancement versions: Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33649> _______________________________________

17 74

[issue39990] help output should make use of typing.get_type_hints
by Nguyễn Gia Phong 03 May '20

03 May '20

New submission from Nguyễn Gia Phong <vn.mcsinyx(a)gmail.com>: With PEP 563, it is legal to annotate a function as follows def foo(bar: 'int') -> 'bool': pass Currently, help(foo) would print the exact signature in foo.__annotations__ and it's not really pretty. My proposal is to use the type hints from typing.get_type_hints to make documentations more readable from the user's perspective. I might not be aware of all use cases and disadvantages of this proposal however. ---------- assignee: docs@python components: Documentation messages: 364399 nosy: McSinyx, docs@python priority: normal severity: normal status: open title: help output should make use of typing.get_type_hints _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39990> _______________________________________

2 4

[issue40419] timeit CLI docs still mention old power sequence
by Sander van Rijn 02 May '20

02 May '20

New submission from Sander van Rijn <svr003(a)gmail.com>: The docs for the `timeit` CLI (https://docs.python.org/3/library/timeit.html#cmdoption-timeit-h) still mention that successive powers of 10 are tried. However, as this also uses the `timeit.Timer.autorange()` function, it uses the new sequence 1, 2, 5, 10, 20, 50, ... instead. ---------- assignee: docs@python components: Documentation messages: 367517 nosy: Sander van Rijn, docs@python priority: normal severity: normal status: open title: timeit CLI docs still mention old power sequence type: enhancement versions: Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40419> _______________________________________

5 8