Mailman 3 November 2021 - Docs-bugs

[issue45742] python -h can't find -R option
by jiahua wang Nov. 14, 2021

Nov. 14, 2021

New submission from jiahua wang <wjh180909(a)gmail.com>: I input python -h on the command line, and I can't find any -R option. ---------- assignee: docs@python components: Documentation messages: 405891 nosy: 180909, docs@python priority: normal severity: normal status: open title: python -h can't find -R option versions: Python 3.10 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45742> _______________________________________

4 9

[issue45799] Fix confusing wording in Doc/library/__main__.rst
by Jack DeVries Nov. 13, 2021

Nov. 13, 2021

New submission from Jack DeVries <jdevries3133(a)gmail.com>: I was reading this bit last night and thought it was a typo. In the light of day, I realized it wasn't *technically* a typo, but definitely confusing wording. This PR fixes the confusing sentence. ---------- assignee: docs@python components: Documentation messages: 406279 nosy: docs@python, jack__d priority: normal severity: normal status: open title: Fix confusing wording in Doc/library/__main__.rst type: enhancement versions: Python 3.10, Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45799> _______________________________________

3 5

[issue45762] Missing `list` symbols in the object inventory
by Matteo Bertucci Nov. 13, 2021

Nov. 13, 2021

New submission from Matteo Bertucci <matteobertucci2004(a)gmail.com>: Sphinx generates a quite useful inventory file, listing all the different symbols available inside the documentation. You can find the docs.python.org inventory over at https://docs.python.org/objects.inv. The syntax of this file can be found here https://sphobjinv.readthedocs.io/en/latest/syntax.html. We use it over at Python Discord to power up our `!docs` command. It allows us to look up symbols such as `asyncio.run`, have nicely formatted documentation and links to the web page. The problem is due to where the `list` method documentations are located, inside `/tutorial/datastructures` (https://docs.python.org/3/tutorial/datastructures.html), no symbol is exported for those, making commands such as `!docs list.append` fail, which is quite a bummer. It would be very nice to have access to those. ---------- assignee: docs@python components: Documentation messages: 406004 nosy: Akarys, docs@python priority: normal severity: normal status: open title: Missing `list` symbols in the object inventory versions: Python 3.10, Python 3.11, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45762> _______________________________________

3 2

[issue45772] socket.socket should be a class instead of a function
by Oleg Iarygin Nov. 13, 2021

Nov. 13, 2021

New submission from Oleg Iarygin <oleg(a)arhadthedev.net>: Found a twice stale bpo-less but useful pull request 23960, so publish it here: > Currently socket.socket is documented as a function, but it is really a class (and thus has function-like usage to construct an object). This correction would ensure that Python projects that are interlinking Python's documentation can properly locate socket.socket as a type. ---------- assignee: docs@python components: Documentation messages: 406045 nosy: arhadthedev, docs@python, xuhdev priority: normal pull_requests: 27751 severity: normal status: open title: socket.socket should be a class instead of a function versions: Python 3.10, Python 3.11, Python 3.6, Python 3.7, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45772> _______________________________________

4 8

[issue44995] "Hide the prompts and output" works abnormal
by 杨青 Nov. 13, 2021

Nov. 13, 2021

New submission from 杨青 <nwpu.yangqing(a)qq.com>: 【url】https://docs.python.org/3/tutorial/classes.html 【chapter】9.4. Random Remarks 【problem description】 When I click on the demo "Hide the prompts and output" switch, the class definition statements were also hided. Please take a look as the appended screenshot. ---------- assignee: docs@python components: Documentation files: screenshot.png messages: 400245 nosy: docs@python, yangqing priority: normal severity: normal status: open title: "Hide the prompts and output" works abnormal versions: Python 3.9 Added file: https://bugs.python.org/file50235/screenshot.png _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44995> _______________________________________

4 3

[issue45787] HOWTO for socket programming and select documentation contradict
by Alex Waygood Nov. 11, 2021

Nov. 11, 2021

New submission from Alex Waygood <Alex.Waygood(a)Gmail.com>: The HOWTO for socket programming in Python (https://docs.python.org/3/howto/sockets.html#non-blocking sockets) includes the following lines (using triple-quotes here to indicate multiline quotes from the docs): """ The major mechanical difference [between blocking and non-blocking sockets] is that [for non-blocking sockets] send, recv, connect and accept can return without having done anything. You have (of course) a number of choices. You can check return code and error codes and generally drive yourself crazy. If you don’t believe me, try it sometime. Your app will grow large, buggy and suck CPU. So let’s skip the brain-dead solutions and do it right. Use select. """ However, if you go to the documentation for the select module (https://docs.python.org/3/library/select html), it pointedly tells you at the top *not* to do exactly what the socket HOWTO tells you to do: """ Note The selectors module allows high-level and efficient I/O multiplexing, built upon the select module primitives. Users are encouraged to use the selectors module instead, unless they want precise control over the OS-level primitives used. """ ---------- assignee: docs@python components: Documentation messages: 406167 nosy: AlexWaygood, docs@python, giampaolo.rodola, neologix priority: normal severity: normal status: open title: HOWTO for socket programming and select documentation contradict type: behavior versions: Python 3.10, Python 3.11, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45787> _______________________________________

1 0

[issue21501] docs: mmap example for use in documentation
by Guido van Rossum Nov. 10, 2021

Nov. 10, 2021

Guido van Rossum <guido(a)python.org> added the comment: Thanks for the research! I will close the issue now. ---------- resolution: -> out of date stage: -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue21501> _______________________________________

1 0

[issue21501] docs: mmap example for use in documentation
by mike mcleod Nov. 10, 2021

Nov. 10, 2021

mike mcleod <mikecmcleod(a)gmail.com> added the comment: One of the things I did when the example code didn't work was to see what other examples could be found and there are I would argue plenty or just enough, eg: https://medium.com/analytics-vidhya/memory-mapping-files-and-mmap-module-in… And google will fetch more if needed. May I suggest back in 2014 when the issue was raised that this may have been a good example, but mmap is not so new and in the intervening time anybody who needed further examples simply googled them. Hence, I suggest its not needed. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue21501> _______________________________________

1 0

[issue21501] docs: mmap example for use in documentation
by Guido van Rossum Nov. 10, 2021

Nov. 10, 2021

Guido van Rossum <guido(a)python.org> added the comment: We would need the OP to sign a CLA in order to be able to use (a modified version of) his code. I presume this page is where the example was supposed to go? https://docs.python.org/3/library/mmap.html Let me ask first -- does that page really need another example? If so, is the OP's example (made working) really the best one? Perhaps there are blog posts that cover how to use mmap already, and the reference docs don't need such an extensive example? In that case we could just close this (ancient) issue. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue21501> _______________________________________

1 0

[issue21501] docs: mmap example for use in documentation
by mike mcleod Nov. 10, 2021

Nov. 10, 2021

mike mcleod <mikecmcleod(a)gmail.com> added the comment: I would like to help with this issue. I note that a few changes need to be made to the code example for compatibility for the latest version of Python. I can get this working but I am not sure this is a good example. Also, the example is more about threads and messaging between threads rather than mmap. So my question is is this a good example? And the suggestion of adding detailed explanation of the code, again, as to what it does not seem to be that relevant to mmap. ---------- nosy: +mikecmcleod _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue21501> _______________________________________

1 0