Mailman 3 May 2020 - docs

[issue40202] Misleading grammatically of ValueError Message?
by Jacob RR 03 Oct '20

03 Oct '20

New submission from Jacob RR <xboxgamermaple(a)gmail.com>: hi, so I *think* that ValueError shows an error grammatically incorrect? In python 2.7 >>> x = [1,2,3] >>> f,x, a, b = [1,2,3] Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: need more than 3 values to unpack Should have said: Received 3 values to unpack ? The problem with that is the list size is 3 and the error says that I need more than 3 values to unpack which is logically wrong **IMHO** (don't kill me if im mistaken) Now if I try to do something else, for example: >>> x = [1,2,3] >>> a, b = [1,2,3] Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: too many values to unpack It says **too many** but I assign a few than the size of the list. am I the one who wrong here? Now, I code in Python 3 I'm not a professional like you, I'm novice and try to learn.. I'll get to the point, the same code in Python 3.7.6 (Anaconda, pip is disappoint me :< ) >>> a = [1,2,3] >>> x,y = a Traceback (most recent call last): File "<stdin>", line 1, in <module> ValueError: too many values to unpack (expected 2) Should said something else because it received less values and expected should say 3 and not 2, correct? thanks for reading. PS: Sorry I'm not a native speaker and I might be wrong and am very sorry if time wasted. ---------- assignee: docs@python components: Documentation messages: 365842 nosy: Jacob RR, docs@python priority: normal severity: normal status: open title: Misleading grammatically of ValueError Message? type: enhancement versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40202> _______________________________________

6 8

[issue33235] Better help text for dict.setdefault
by Paddy McCarthy 03 Oct '20

03 Oct '20

New submission from Paddy McCarthy <paddy3118(a)gmail.com>: Hi, I was answering some question and used dict.setdefault as part of the solution and posted the help() on it as part of my answer. The help was this: In [15]: help(mapper.setdefault) Help on built-in function setdefault: setdefault(...) method of builtins.dict instance D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D This seems the wrong way around. Is it not better expressed as D.setdefault(k[,d]) -> set D[k]=d if k not in D and then D.get(k,d) ---------- assignee: docs@python components: Documentation messages: 315015 nosy: Paddy McCarthy, docs@python priority: normal severity: normal status: open title: Better help text for dict.setdefault type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33235> _______________________________________

5 5

[issue39710] "will be returned as unicode" reminiscent from Python 2
by Julien Palard 02 Oct '20

02 Oct '20

New submission from Julien Palard <julien+python(a)palard.fr>: In https://docs.python.org/3/library/calendar.html#calendar.LocaleTextCalendar I read "If this locale includes an encoding all strings containing month and weekday names will be returned as unicode." `unicode` here is a mention of the `unicode` type from Python 2 which does no longer exists, so the whole sentence can just be removed. It happen also in the next paragraph, and twice in Lib/calendar.py. In Python 2: >>> print type(calendar.LocaleTextCalendar(locale="C").formatmonth(2020, 1)) <type 'str'> >>> print type(calendar.LocaleTextCalendar(locale="en_US.UTF8").formatmonth(2020, 1)) <type 'unicode'> In Python 3: >>> print(type(calendar.LocaleTextCalendar(locale="C").formatmonth(2020, 1))) <class 'str'> >>> print(type(calendar.LocaleTextCalendar(locale="en_US.UTF8").formatmonth(2020, 1))) <class 'str'> ---------- assignee: docs@python components: Documentation keywords: easy messages: 362410 nosy: docs@python, mdk priority: normal severity: normal status: open title: "will be returned as unicode" reminiscent from Python 2 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39710> _______________________________________

7 9

[issue40391] io.FileIO.mode doesn't comply with the docs
by mike.parker 02 Oct '20

02 Oct '20

New submission from mike.parker <mike.parker-3ob7b3hc(a)yopmail.com>: io.FileIO.mode doesn't reflect "The mode as given in the constructor." as per the documentation(https://docs.python.org/3/library/io.html#io.FileIO.mode). Was noted in issue4362, but seems to be still relevant. Example: >>> f = open("t.tmp", "w+b") >>> f.mode 'rb+' ---------- assignee: docs@python components: Documentation, IO messages: 367288 nosy: benjamin.peterson, docs@python, mike.parker, stutzbach priority: normal severity: normal status: open title: io.FileIO.mode doesn't comply with the docs type: behavior versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40391> _______________________________________

3 2

[issue29127] Incorrect reference names in asyncio.subprocess documentation
by Eric Ahn 02 Oct '20

02 Oct '20

New submission from Eric Ahn: On this page of the documentation https://docs.python.org/3/library/asyncio-subprocess.html it seems that some of the reference names are incorrect. Namely, asyncio.subprocess.PIPE is referred to as asyncio.asyncio.subprocess.PIPE (along with STDOUT and DEVNULL), plus asyncio.subprocess.Process is referred to as asyncio.asyncio.subprocess.Process. This is reflected in the permalinks as well as when one tries to reference these via intersphinx (which is how I discovered it; I was trying to link to this page and was failing). ---------- assignee: docs@python components: Documentation messages: 284418 nosy: Eric Ahn, docs@python priority: normal severity: normal status: open title: Incorrect reference names in asyncio.subprocess documentation versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29127> _______________________________________

3 2

[issue39027] run_coroutine_threadsafe uses wrong TimeoutError
by janust 28 Sep '20

28 Sep '20

New submission from janust <ysangkok(a)gmail.com>: https://docs.python.org/3.8/library/asyncio-task.html#asyncio.run_coroutine… has a code example that catches a asyncio.TimeoutError from run_coroutine_threadsafe. In Python 3.7, this exception was equal to concurrent.futures.TimeoutError, but since https://github.com/python/cpython/commit/431b540bf79f0982559b1b0e420b1b085f… that is not the case anymore. ---------- assignee: docs@python components: Documentation messages: 358281 nosy: docs@python, janust priority: normal severity: normal status: open title: run_coroutine_threadsafe uses wrong TimeoutError versions: Python 3.8, Python 3.9 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue39027> _______________________________________

5 4

[issue40471] Grammar typo in issubclass docstring
by alexpovel 27 Sep '20

27 Sep '20

New submission from alexpovel <python(a)alexpovel.de>: Running `python -c "help(issubclass)"` will output: > Help on built-in function issubclass in module builtins: > > issubclass(cls, class_or_tuple, /) > Return whether 'cls' is a derived from another class or is the same class. > > A tuple, as in ``issubclass(x, (A, B, ...))``, may be given as the target to > check against. This is equivalent to ``issubclass(x, A) or issubclass(x, B) > or ...`` etc. where it should probably read: > Return whether 'cls' is derived from another class or is the same class. over the current: > Return whether 'cls' is a derived from another class or is the same class. There are two occurrences of this string, one in `./Python/bltinmodule.c`, the other in `./Python/clinic/bltinmodule.c.h`. I have to admit I cannot safely say which of these is the generated file through Argument Clinic and which is the source. Is `./Python/bltinmodule.c` the source, aka where this would need to be changed? Please let me know and I will create a PR. Thanks! ---------- assignee: docs@python components: Documentation messages: 367871 nosy: alexpovel, docs@python priority: normal severity: normal status: open title: Grammar typo in issubclass docstring versions: Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue40471> _______________________________________

5 7

[issue35765] Document references object x but doesn't show it in the example
by Patrick Rice 26 Sep '20

26 Sep '20

New submission from Patrick Rice <price(a)zoox.com>: https://docs.python.org/3.5/tutorial/inputoutput.html If you have an object x, you can view its JSON string representation with a simple line of code: >>> >>> import json >>> json.dumps([1, 'simple', 'list']) '[1, "simple", "list"]' ---------- assignee: docs@python components: Documentation messages: 333917 nosy: Patrick Rice, docs@python priority: normal severity: normal status: open title: Document references object x but doesn't show it in the example versions: Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue35765> _______________________________________

4 3

[issue24757] Installing Py on Windows: Need to restart or logout for path to be added
by John Palermo 24 Sep '20

24 Sep '20

New submission from John Palermo: Something I suppose many new users could stumble over: After installing Python and trying out "pip" or "python" on the command line nothing is found. You have to re-start Windows or re-log into your account. I suggest adding this information to the documentation here https://docs.python.org/2/using/windows.html#installing-python and also adding it to the Windows installer description for the "add Python to your path" option. ---------- assignee: docs@python components: Documentation messages: 247688 nosy: John Palermo, docs@python priority: normal severity: normal status: open title: Installing Py on Windows: Need to restart or logout for path to be added type: enhancement versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24757> _______________________________________

6 6

[issue18280] Documentation is too personalized
by Serhiy Storchaka 19 Sep '20

19 Sep '20

New submission from Serhiy Storchaka: Some documentation files contain a number of I/my/me. Looks like they grew from personal modules and personal articles. Perhaps the official documentation needs more depersonalized style. Here is full list of such files: Doc/c-api/exceptions.rst Doc/c-api/long.rst Doc/distutils/builtdist.rst Doc/extending/extending.rst Doc/extending/windows.rst Doc/howto/argparse.rst Doc/howto/curses.rst Doc/howto/functional.rst Doc/howto/regex.rst Doc/howto/sockets.rst Doc/howto/urllib2.rst Doc/install/index.rst Doc/library/audioop.rst Doc/library/ctypes.rst Doc/library/doctest.rst Doc/library/heapq.rst Doc/library/numbers.rst Doc/library/ossaudiodev.rst Doc/library/tk.rst Doc/library/unittest.mock-examples.rst Doc/library/unittest.mock.rst Doc/reference/introduction.rst Doc/tutorial/classes.rst The list doesn't include FAQs where it may be appropriate and whatsnew files. Andrew Kuchling recently has fixed Doc/howto/unicode.rst for this issue (as part of issue4153). ---------- assignee: docs@python components: Documentation messages: 191636 nosy: akuchling, docs@python, eric.araujo, ezio.melotti, georg.brandl, serhiy.storchaka priority: normal severity: normal status: open title: Documentation is too personalized versions: Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18280> _______________________________________

11 17