Mailman 3 February 2021 - docs

[issue43094] sqlite3.create_function takes parameter named narg, not num_params
by Nicholas Chammas March 28, 2021

March 28, 2021

New submission from Nicholas Chammas <nicholas.chammas(a)gmail.com>: The doc for sqlite3.create_function shows the signature as follows: https://docs.python.org/3.9/library/sqlite3.html#sqlite3.Connection.create_… ``` create_function(name, num_params, func, *, deterministic=False) ``` But it appears that the parameter name is `narg`, not `num_params`. Trying `num_params` yields: ``` TypeError: function missing required argument 'narg' (pos 2) ``` ---------- assignee: docs@python … [View More]

3 12

[issue35026] Winreg's documentation lacks mentioning required permission at some points
by George Fischhof March 28, 2021

March 28, 2021

New submission from George Fischhof <george(a)fischhof.hu>: Winreg's documentation lacks mentioning required permission at some points Hi there, on page https://docs.python.org/3/library/winreg.html it is not mentioned in the description of the following functions: winreg.DeleteKey winreg.DeleteKeyEx winreg.DeleteValue that they require KEY_SET_VALUE when the registry key is opened. It is mentioned for example at: winreg.SetValue with the following text: The key identified by the … [View More]

4 4

[issue39231] Mistaken notion in tutorial
by Robert March 27, 2021

March 27, 2021

New submission from Robert <freshbob1337(a)gmail.com>: https://docs.python.org/3/tutorial/controlflow.html 4.7.8. Function Annotations [...] "The following example has a positional argument, a keyword argument, and the return value annotated:" It is not a "positional argument" but an "optional argument". ---------- assignee: docs@python components: Documentation messages: 359443 nosy: docs@python, r0b priority: normal severity: normal status: open title: Mistaken notion in tutorial … [View More]

5 9

[issue39616] SSLContext.check_hostname description is inaccurate wrt match_hostname
by Ville Skyttä March 27, 2021

March 27, 2021

New submission from Ville Skyttä <ville.skytta(a)iki.fi>: Doc says "Whether to match the peer cert’s hostname with match_hostname() in SSLSocket.do_handshake()." but match_hostname() is no longer used to do that in the first place, OpenSSL is used for that. check_hostname affects the OpenSSL usage, too. ---------- assignee: docs@python components: Documentation messages: 361892 nosy: docs@python, scop priority: normal severity: normal status: open title: SSLContext.check_hostname … [View More]

3 7

[issue39369] Doc: Update mmap readline method documentation
by Wellington PF March 26, 2021

March 26, 2021

New submission from Wellington PF <wellpardim10(a)gmail.com>: Update mmap readline method description. The fact that the readline method does update the file position should not be ignored since this might give the impression for the programmer that it doesn't update it. ---------- assignee: docs@python components: Documentation messages: 360191 nosy: docs@python, wellpardim priority: normal pull_requests: 17435 severity: normal status: open title: Doc: Update mmap readline method … [View More]

3 2

[issue21297] skipinitialspace in the csv module only skips spaces, not "whitespace" in general
by Daniel Andersson March 25, 2021

March 25, 2021

New submission from Daniel Andersson: Regarding the `skipinitialspace` parameter to the different CSV reader dialects in the `csv` module, the official documentation asserts: When True, whitespace immediately following the delimiter is ignored. and the `help(csv)` style module documentation says: * skipinitialspace - specifies how to interpret whitespace which immediately follows a delimiter. It defaults to False, which means that whitespace immediately following a … [View More]

6 9

[issue37405] socket.getsockname() returns string instead of tuple
by Brent Gardner March 23, 2021

March 23, 2021

New submission from Brent Gardner <bggardner(a)gmail.com>: In Python 3.5.3, a socket with type AF_CAN returns a tuple in the form `(interface, )` from getsockname(). In Python 3.7.3, getsockname() returns a string (the name of the interface). The documentation states "a tuple is used for the AF_CAN address family". The string will break code that worked in 3.5.3 by raising errors such as "Value Error: too many values to unpack (expected 2)". Example: #3.5.3 import socket s = socket.… [View More]

6 11

[issue35118] Add peek() or first() method in queue
by Windson Yang March 23, 2021

March 23, 2021

New submission from Windson Yang <wiwindson(a)gmail.com>: I found other languages like Java and C++ have the method to access the first value in Queue like first() and peek(). Since we use deque_ to create Queue now, it's easy to implement in python using the index. Otherwise, we can add this to the document? I also found some discussion_ here. .. _deque: https://github.com/python/cpython/blob/master/Lib/queue.py#L205 .. _discussion https://mail.python.org/pipermail/python-list/… [View More]

3 11

[issue42444] pathlib.PurePath properties annotated with .. data directive
by Paul Ganssle March 22, 2021

March 22, 2021

New submission from Paul Ganssle <p.ganssle(a)gmail.com>: Currently, it seems that the pathlib module uses `.. data::` to annotate the properties of the PurePath type (e.g. .parts, .drive, .root, etc). See: https://github.com/python/cpython/blob/ff420f0e08a2443339da0df7ace95e14177b… According to the documentation (https://devguide.python.org/documenting/#information-units), `data` is for module-level constants, specifically: > Describes global data in a module, including both … [View More]

2 1

[issue37860] Add netlify deploy preview for docs
by Ashwin Ramaswami March 22, 2021

March 22, 2021

New submission from Ashwin Ramaswami <aramaswamis(a)gmail.com>: It would be good to preview the cpython documentation on PRs using Netlify. See https://github.com/python/core-workflow/issues/348 ---------- assignee: docs@python components: Documentation messages: 349752 nosy: docs@python, epicfaace priority: normal severity: normal status: open title: Add netlify deploy preview for docs versions: Python 3.9 _______________________________________ Python tracker <report(a)bugs.… [View More]

6 15