]> granicus.if.org Git - python/commitdiff
Add a missing docstring
authorRaymond Hettinger <python@rcn.com>
Tue, 24 Nov 2015 04:47:05 +0000 (20:47 -0800)
committerRaymond Hettinger <python@rcn.com>
Tue, 24 Nov 2015 04:47:05 +0000 (20:47 -0800)
Lib/collections.py

index 1dcd23316afdfca8387e496b88e1a2c425d480a0..66e8a24da1d6c66130f413dfe71715b86bf842ad 100644 (file)
@@ -1,3 +1,15 @@
+'''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
+* 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
+
+'''
+
 __all__ = ['Counter', 'deque', 'defaultdict', 'namedtuple', 'OrderedDict']
 # For bootstrapping reasons, the collection ABCs are defined in _abcoll.py.
 # They should however be considered an integral part of collections.py.