From: Raymond Hettinger Date: Tue, 24 Nov 2015 04:43:28 +0000 (-0800) Subject: Add a missing docstring X-Git-Tag: v3.6.0a1~995^2 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c9c3dd87c1235dfaae49602ec7ba279b6d6be9a3;p=thirdparty%2FPython%2Fcpython.git Add a missing docstring --- diff --git a/Lib/collections/__init__.py b/Lib/collections/__init__.py index e8312a9088ff..5b47e608710d 100644 --- a/Lib/collections/__init__.py +++ b/Lib/collections/__init__.py @@ -1,3 +1,19 @@ +'''This module implements specialized container datatypes providing +alternatives to Python’s general purpose built-in containers, dict, +list, set, and tuple. + +* namedtuple factory function for creating tuple subclasses with named fields +* deque list-like container with fast appends and pops on either end +* ChainMap dict-like class for creating a single view of multiple mappings +* Counter dict subclass for counting hashable objects +* OrderedDict dict subclass that remembers the order entries were added +* defaultdict dict subclass that calls a factory function to supply missing values +* UserDict wrapper around dictionary objects for easier dict subclassing +* UserList wrapper around list objects for easier list subclassing +* UserString wrapper around string objects for easier string subclassing + +''' + __all__ = ['deque', 'defaultdict', 'namedtuple', 'UserDict', 'UserList', 'UserString', 'Counter', 'OrderedDict', 'ChainMap']