Mailman 3 April 2017 - docs

Typo in the Python 2.7 tutorial, section 3.1.2
by Ted Clark April 10, 2017

April 10, 2017

There's a typo in the Python 2.7 tutorial, section 3.1.2: >>> 'doesn\'t' # use \' to escape the single quote... "doesn't" should be: >>> 'doesn\'t' # use \' to escape the single quote... 'doesn\'t'

1 1

[issue14039] Add "metavar" argument to add_subparsers() in argparse
by Martin Panter April 10, 2017

April 10, 2017

Martin Panter added the comment: Thanks to Issue 11807, the documentation now lists “metavar”. (However, it looks like a positional argument, rather than keyword-only, and its use seems to be discouraged, but those issues are not specific to “metavar”.) Some points specific to “metavar” that I think could be clarified: 1. Metavar seems to affect the placeholder in the “usage” message, and a heading that precedes a multi-line list of commands, but it does not affect the presentation of the multi-line list itself. 2. The relationship between the “metavar” parameter of “add_argument” and “add_subparsers” needs clarifying. At the moment, there is a hyperlink, which implies that the description of add_argument’s parameter applies to add_subparsers. But it only discusses the “dest” parameter and CLI options (a.k.a. “optionals”), neither of which make sense in the context of subcommands. Issue 29030 (choices vs metavar) may be related. ---------- assignee: -> docs@python components: +Documentation -Library (Lib) nosy: +docs@python, martin.panter versions: +Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14039> _______________________________________

1 0

[issue30026] Hashable doesn't check for __eq__
by Max April 9, 2017

April 9, 2017

New submission from Max: I think collections.abc.Hashable.__subclasshook__ should check __eq__ method in addition to __hash__ method. This helps detect classes that are unhashable due to: to __eq__ = None Of course, it still cannot detect: def __eq__: return NotImplemented but it's better than nothing. In addition, it's probably worth documenting that explicitly inheriting from Hashable has (correct but unexpected) effect of *suppressing* hashability that was already present: from collections.abc import Hashable class X: pass assert issubclass(X, Hashable) x = X() class X(Hashable): pass assert issubclass(X, Hashable) x = X() # Can't instantiate abstract class X with abstract methods ---------- assignee: docs@python components: Documentation, Interpreter Core messages: 291382 nosy: docs@python, max priority: normal severity: normal status: open title: Hashable doesn't check for __eq__ _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30026> _______________________________________

2 2

[issue30023] Example code becomes invalid for "Why do lambdas defined in a loop with different values all return the same result?"
by Philip Lee April 9, 2017

April 9, 2017

New submission from Philip Lee: There example code here becomes invalid https://docs.python.org/3/faq/programming.html#why-do-lambdas-defined-in-a-… >>> squares = [] >>> for x in range(5): squares.append(lambda: x**2) >>> squares [<function <lambda> at 0x01FB7A08>, <function <lambda> at 0x01F82390>, <function <lambda> at 0x01FBA3D8>, <function <lambda> at 0x01FBA420>, <function <lambda> at 0x01FBA468>] >>> There returned value is a List of lambda functions, not numbers ---------- assignee: docs@python components: Documentation messages: 291353 nosy: docs@python, iMath priority: normal severity: normal status: open title: Example code becomes invalid for "Why do lambdas defined in a loop with different values all return the same result?" type: enhancement versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30023> _______________________________________

2 2

[issue29506] Incorrect documentation for the copy module
by Pedro April 9, 2017

April 9, 2017

New submission from Pedro: The docs for the copy module contain a bullet that says the following: "Because deep copy copies everything it may copy too much, e.g., even administrative data structures that should be shared even between copies." There should be a "not" between "should" and "be shared." I think the second "even" can be dropped, too. ---------- assignee: docs@python components: Documentation messages: 287367 nosy: docs@python, pgacv2 priority: normal severity: normal status: open title: Incorrect documentation for the copy module versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29506> _______________________________________

9 22

[issue22702] to improve documentation for join() (str method)
by Nick Coghlan April 9, 2017

April 9, 2017

Nick Coghlan added the comment: Noting for the record: Marco Buttu proposed my suggested approach on the PR back in early March. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22702> _______________________________________

1 0

[issue22702] to improve documentation for join() (str method)
by Nick Coghlan April 9, 2017

April 9, 2017

Nick Coghlan added the comment: Raymond, in the review comments on https://github.com/python/cpython/pull/156 Xiang noted that the current apparently duplicated iterable isn't entirely redundant: - the first reference is to the term "iterable" - the second reference is to the parameter name "*iterable*" "Return a string which is the concatenation of the strings in the :term:`iterable` *iterable*." So if we're going to drop one of them, it should probably be the link to the term, rather than the parameter name: "Return a string which is the concatenation of the strings in *iterable*." Does that sound reasonable to you? ---------- nosy: +ncoghlan, xiang.zhang _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22702> _______________________________________

1 0

[issue29725] sqlite3.Cursor doesn't properly document "arraysize"
by Jürgen A. Erhard April 8, 2017

April 8, 2017

New submission from Jürgen A. Erhard: It's an attribute mentioned in fetchmany and fetchall, but it's not in the list with those two, but it should be, since the section says "A Cursor instance has the following attributes and methods." and it is an attribute. ---------- assignee: docs@python components: Documentation messages: 289023 nosy: docs@python, jae priority: normal severity: normal status: open title: sqlite3.Cursor doesn't properly document "arraysize" _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29725> _______________________________________

5 16

[issue29975] Issue in extending documentation
by Namjun Kim April 7, 2017

April 7, 2017

New submission from Namjun Kim: https://docs.python.org/3.7/extending/extending.html "Should it become a dangling pointer, C code which raises the exception could cause a core dump or other unintended side effects." The typo error in this sentence. "If it become a dangling pointer, C code which raises the exception could cause a core dump or other unintended side effects." fix the typo error. ---------- assignee: docs@python components: Documentation messages: 291098 nosy: Namjun Kim, docs@python priority: normal severity: normal status: open title: Issue in extending documentation versions: Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29975> _______________________________________

4 3

[issue30001] CPython contribution docs reference missing /issuetracker page
by AJ Jordan April 6, 2017

April 6, 2017

New submission from AJ Jordan: https://cpython-devguide.readthedocs.io/pullrequest.html#licensing (and presumably other pages in this project) references https://cpython-devguide.readthedocs.io/issuetracker, but this page returns 404 Not Found. ---------- assignee: docs@python components: Documentation messages: 291202 nosy: docs@python, strugee priority: normal severity: normal status: open title: CPython contribution docs reference missing /issuetracker page _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30001> _______________________________________

3 2