Mailman 3 January 2017 - docs

spelling error at https://docs.python.org/3/library/bisect.html#module-bisect
by keith.briggs＠bt.com Jan. 10, 2017

Jan. 10, 2017

"straight-forward" should be "straightforward". Keith

1 0

[issue29217] Documentation for uuid has wrong description for variant
by David Muller Jan. 10, 2017

Jan. 10, 2017

New submission from David Muller: The documentation's description for uuid.variant says that its value is one of several integer constants, but those constants are actually strings. ---------- assignee: docs@python components: Documentation messages: 285079 nosy: TigerhawkT3, docs@python priority: normal severity: normal status: open title: Documentation for uuid has wrong description for variant type: behavior versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 … [View More]

3 2

[issue9182] document “--” as a way to distinguish option w/ narg='+' from positional argument in argparse
by paul j3 Jan. 10, 2017

Jan. 10, 2017

Changes by paul j3 <ajipanca(a)gmail.com>: ---------- nosy: +paul.j3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9182> _______________________________________

1 0

[issue29133] Minor inaccuracy in shlex.shlex punctuation_chars example
by Evan Jan. 9, 2017

Jan. 9, 2017

New submission from Evan: https://docs.python.org/3/library/shlex.html#improved-compatibility-with-sh… The code sample here does not match the output - the first line is labelled 'New' and the second line 'Old'. ---------- assignee: docs@python components: Documentation messages: 284481 nosy: docs@python, evan_ priority: normal severity: normal status: open title: Minor inaccuracy in shlex.shlex punctuation_chars example versions: Python 3.6, Python 3.7 … [View More]

5 10

[issue9182] document “--” as a way to distinguish option w/ narg='+' from positional argument in argparse
by Berker Peksag Jan. 8, 2017

Jan. 8, 2017

Changes by Berker Peksag <berker.peksag(a)gmail.com>: ---------- nosy: +berker.peksag _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue9182> _______________________________________

1 0

[issue29002] typing.AnyStr doc is unclear about python2 unicode support
by Alex Jurkiewicz Jan. 7, 2017

Jan. 7, 2017

New submission from Alex Jurkiewicz: The typing.AnyStr documentation: https://docs.python.org/3/library/typing.html#typing.AnyStr It gives some examples using u-strings (u'foo') but doesn't make explicit some subtleties about behaviour with Python 2. Specifically, with Python 2 all the given examples work, and even this works: concat("foo", u"bar") Which seems contrary to the goal of AnyStr being "used for functions that may accept any kind of string without allowing different kinds of … [View More]

4 4

[issue16026] csv.DictReader argument names documented incorrectly
by Peter Eisentraut Jan. 7, 2017

Jan. 7, 2017

New submission from Peter Eisentraut: The documentation for the csv.DictReader constructor is .. class:: DictReader(csvfile, fieldnames=None, restkey=None, restval=None, dialect='excel', *args, **kwds) but the implementation is def __init__(self, f, fieldnames=None, restkey=None, restval=None, dialect="excel", *args, **kwds): The name of the first argument is documented incorrectly, leading to surprise errors when attempting to use key word arguments. ---------- assignee: docs@python … [View More]

9 15

[issue29023] Results of random.seed() call with integer argument should be claimed deterministic.
by Jakub Mateusz Kowalski Jan. 7, 2017

Jan. 7, 2017

New submission from Jakub Mateusz Kowalski: In https://docs.python.org/2/library/random.html#random.seed I can find that "If a hashable object is given, deterministic results are only assured when PYTHONHASHSEED is disabled." Both int and long are hashable. However, tests on the random module as well as C source code of random_seed (as indicated in http://stackoverflow.com/a/41228062/4879688) suggest that behaviour of the module is deterministic when seeded with an integer. ---------- … [View More]

3 6

[issue29175] Documentation for File objects missing
by Jonathan Roach Jan. 6, 2017

Jan. 6, 2017

New submission from Jonathan Roach: The file documentation (as seen in python.org) went missing in 3.3. In 2.7.13 it can be found in 'The Python Standard Library' as section '5.9 File Objects', between '5.8 Mapping Types' and '5.10 memory view type'. In 3.3 and onwards this section is no longer present, and, as far as I can tell, is not present elsewhere in the documentation. [related: in 'The Python Tutorial' section '7.2.1 Methods of File Objects' the inline references to the file object … [View More]

2 2

A badly documented page
by Dhananjay Naniwadekar Jan. 6, 2017

Jan. 6, 2017

Refer, please : https://docs.python.org/2/howto/argparse.html Search for the first instance of : args.square When you want to show that : Square of 5 is 25, calling the number '5' args.square is very counterintuitive. If you call it args.base_number, it does not at once tell whether the square or cube or root of the base is being calcaulated. Calling it args.num_to_be_squared is too long. But calling it args.square is so confusing. print args.num**2 ## print the square of the number … [View More]

1 0