]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
Add a missing docstring
authorRaymond Hettinger <python@rcn.com>
Tue, 24 Nov 2015 04:43:28 +0000 (20:43 -0800)
committerRaymond Hettinger <python@rcn.com>
Tue, 24 Nov 2015 04:43:28 +0000 (20:43 -0800)
Lib/collections/__init__.py

index e8312a9088ffdb215b7a4bb43fe30a81f618895d..5b47e608710db7c5dc525469146349b07757fb5d 100644 (file)
@@ -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']