[New-bugs-announce] [issue15831] comma after leading optional argument is after bracket in docs
report at bugs.python.org
Fri Aug 31 17:57:14 CEST 2012
New submission from Chris Jerdonek:
>From docs at python.org:
In a number of places we find documentation with optional leading arguments where the meta-notation (square brackets) are in the wrong place. For example, for range, the standard doc heading says
range([start], stop [, step]) # The comma after start should be inside the square bracket, not outside.
The same error occurs with docs for print, and for slice, for random.randrange and for random.seed, etc, etc. This seems a consistent bug whenever a function or method takes an optional first argument, and it looks like it might have been put there by some tool that generates the docs.
I use Python 3 - perhaps there was once a time when one had to supply the comma if one omitted the first argument? In Python 3 it gives errors if one follows the documentation carefully and uses the comma.
(or see http://mail.python.org/pipermail/docs/2012-August/010051.html )
assignee: docs at python
nosy: cjerdonek, docs at python
title: comma after leading optional argument is after bracket in docs
versions: Python 2.7, Python 3.2, Python 3.3
Python tracker <report at bugs.python.org>
More information about the New-bugs-announce