Python 3 documentation bugs?
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. Thanks Peter
Hello Peter, this has been reported at http://bugs.python.org/issue15831 . Regards, Sandro On Thu, Aug 30, 2012 at 6:37 PM, Peter Wentworth <p.wentworth@ru.ac.za> wrote:
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.
Thanks
Peter
_______________________________________________ docs mailing list docs@python.org http://mail.python.org/mailman/listinfo/docs
-- Sandro Tosi (aka morph, morpheus, matrixhasu) My website: http://matrixhasu.altervista.org/ Me at Debian: http://wiki.debian.org/SandroTosi
participants (2)
-
Peter Wentworth -
Sandro Tosi