Mailman 3 November 2021 - Docs-bugs

[issue45728] SharedMemory documentation: System V vs Posix
by jkrupp Nov. 6, 2021

Nov. 6, 2021

New submission from jkrupp <python_cee2df(a)jkrupp.de>: Hi, the documentation for the shared_memory module states that "shared memory refers to “System V style” shared memory". However, I believe it might be clearer to talk about "POSIX style shared memory" here instead. Primed by the "System V style"-comment, I had expected that shared memory blocks could be identified through a numeric ID (as used by the system V shared memory APIs `shmget`, `shmat`, ...). After looking at the implementation it became clear though, that the newer POSIX-API (`shm_open`, `shm_unlink`, ...) is used, which explains why shared memory blocks have a *name* instead. Technically, the documentation only uses "System V style" to distinguish it from "distributed shared memory", and further states that "[it] is not necessarily implemented explicitly as such". Yet, this distinction is particularly relevant if memory is to be shared with other (non-python!) processes (although placement of shared_memory in the multiprocessing package might indicate that that is not one of its expected use-cases...) ---------- assignee: docs@python components: Documentation messages: 405797 nosy: docs@python, jkrupp priority: normal severity: normal status: open title: SharedMemory documentation: System V vs Posix type: enhancement versions: Python 3.10, Python 3.11, Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45728> _______________________________________

2 1

[issue45722] documentation missing information on objects in submodules
by Jens Rapp Nov. 6, 2021

Nov. 6, 2021

New submission from Jens Rapp <rapp.jens(a)googlemail.com>: Documentation 5.4.2. Submodules tells what happens to modules which are imported inside __init__.py of a package> from .foo import Foo from .bar import Bar then executing the following puts a name binding to foo and bar in the spam module: >>> >>> import spam >>> spam.foo <module 'spam.foo' from '/tmp/imports/spam/foo.py'> >>> spam.bar <module 'spam.bar' from '/tmp/imports/spam/bar.py'> I miss information on what happes to Foo and Bar. is it directly usable under spam.Bar() or does one have to use spam.bar.Bar()? To my mind, that example should tell this. ---------- assignee: docs@python components: Documentation messages: 405769 nosy: docs@python, rapp.jens priority: normal severity: normal status: open title: documentation missing information on objects in submodules type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45722> _______________________________________

2 1

[issue45726] Documentation for `@singledispatch` and `@singledispatchmethod` could be improved
by Alex Waygood Nov. 5, 2021

Nov. 5, 2021

New submission from Alex Waygood <Alex.Waygood(a)Gmail.com>: The documentation for `functools.singledispatch` and `functools.singledispatchmethod` contains a few small grammar mistakes and instances of slightly inelegant writing. PR to follow shortly. ---------- assignee: docs@python components: Documentation messages: 405788 nosy: AlexWaygood, docs@python, lukasz.langa, rhettinger priority: normal severity: normal status: open title: Documentation for `@singledispatch` and `@singledispatchmethod` could be improved type: enhancement versions: Python 3.10, Python 3.11, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue45726> _______________________________________

3 5

[issue38401] Make dataclass attribute docstrings accessible
by Václav Brožík Nov. 5, 2021

Nov. 5, 2021

Václav Brožík <pabouk(a)gmail.com> added the comment: Note that John Parejko is right that the active PEP 257 clearly specifies attribute docstrings. Here is the excerpt: String literals occurring immediately after a simple assignment at the top level of a module, class, or __init__ method are called "attribute docstrings". They are being supported by various software like Sphinx, vim, VS Codes's Pylance. ---------- nosy: +pabouk _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue38401> _______________________________________

1 0

[issue40051] Give proper link in help(idlelib/turtledemo/tkinter.sub/test_*/?)
by Zachary Ware Nov. 5, 2021

Nov. 5, 2021

Zachary Ware <zachary.ware(a)gmail.com> added the comment: This actually turned out to be less effort than I expected (though I still should have been asleep 2 hours ago), so I've gone ahead and opened GH-29419 to implement what I suggested. ---------- stage: patch review -> test needed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40051> _______________________________________

1 0

[issue40051] Give proper link in help(idlelib/turtledemo/tkinter.sub/test_*/?)
by Zachary Ware Nov. 5, 2021

Nov. 5, 2021

Change by Zachary Ware <zachary.ware(a)gmail.com>: ---------- keywords: +patch pull_requests: +27672 stage: test needed -> patch review pull_request: https://github.com/python/cpython/pull/29419 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40051> _______________________________________

1 0

[issue40051] Give proper link in help(idlelib/turtledemo/tkinter.sub/test_*/?)
by Joshua Nov. 5, 2021

Nov. 5, 2021

Joshua <joshua(a)himmens.com> added the comment: I think that option 4 would work best but instead of putting any logic in (Lib/pydoc_data/topics.py)[https://github.com/python/cpython/blob/main/Lib/p… we could put the logic for working with private modules as well and other edge cases in (Lib/pydoc.py)[https://github.com/python/cpython/blob/main/Lib/pydoc.py]. It might make future changes easier. ---------- nosy: +Joshuah143 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40051> _______________________________________

1 0

[issue40051] Give proper link in help(idlelib/turtledemo/tkinter.sub/test_*/?)
by Zachary Ware Nov. 5, 2021

Nov. 5, 2021

Zachary Ware <zachary.ware(a)gmail.com> added the comment: Option 4: generate a list of modules (or a mapping of module names to documentation files) that have documentation when generating Lib/pydoc_data/topics.py, and teach pydoc.help to not include the link when it knows the module doesn't have documentation. This is a much more complete solution that also avoids creating links for private modules (see bpo-45717), but is significantly more effort to implement. ---------- nosy: +zach.ware _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40051> _______________________________________

1 0

[issue44257] typo and verbous grammar in the grammar spec
by ShinWonho Nov. 4, 2021

Nov. 4, 2021

New submission from ShinWonho <new170527(a)kaist.ac.kr>: In Python Language Reference 10.Full Grammar Specification typo: assigment_expression verbous grammar: expressions and star_expression ---------- assignee: docs@python components: Documentation messages: 394630 nosy: docs@python, orangebana15 priority: normal severity: normal status: open title: typo and verbous grammar in the grammar spec type: enhancement versions: Python 3.11 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue44257> _______________________________________

4 6

[issue28124] Rework SSL module documentation
by Erlend E. Aasland Nov. 4, 2021

Nov. 4, 2021

Change by Erlend E. Aasland <erlend.aasland(a)innova.no>: ---------- assignee: docs@python -> components: +Documentation, SSL -Build nosy: +cheryl.sabella, christian.heimes, docs@python, miss-islington -ahmedsayeed1982 versions: +Python 3.8 -Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue28124> _______________________________________

1 0