[docs] Bug in __doc__ of collections.deque

Sam Ghods sam at box.com
Mon Oct 22 12:06:01 CEST 2012

Hi there,

In the official documentation of collections.deque (
http://docs.python.org/library/collections.html#collections.deque ),
iterable is an optional first argument. In collections.deque.__doc__, it is
not marked as optional:

Python 2.7.3 (v2.7.3:70274d53c1dd, Apr  9 2012, 20:52:43)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from collections import deque
>>> print deque.__doc__
deque(iterable[, maxlen]) --> deque object

Build an ordered collection with optimized access from its endpoints.

I believe iterable actually is optional, and the __doc__ should be fixed.
Is this the right list for that?

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20121022/f3e207c9/attachment-0001.html>

More information about the docs mailing list