New submission from Chris Jerdonek:
>From [email protected]:
"""
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@python
components: Documentation
messages: 169547
nosy: cjerdonek, docs@python
priority: normal
severity: normal
status: open
title: comma after leading optional argument is after bracket in docs
type: behavior
versions: Python 2.7, Python 3.2, Python 3.3
_______________________________________
Python tracker <[email protected]>
<http://bugs.python.org/issue15831>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe:
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
