[Python-checkins] cpython (3.5): Add a missing docstring

raymond.hettinger python-checkins at python.org
Mon Nov 23 23:44:04 EST 2015


https://hg.python.org/cpython/rev/935e29e1bbe1
changeset:   99321:935e29e1bbe1
branch:      3.5
parent:      99317:4ed70c568baf
user:        Raymond Hettinger <python at rcn.com>
date:        Mon Nov 23 20:43:28 2015 -0800
summary:
  Add a missing docstring

files:
  Lib/collections/__init__.py |  16 ++++++++++++++++
  1 files changed, 16 insertions(+), 0 deletions(-)


diff --git a/Lib/collections/__init__.py b/Lib/collections/__init__.py
--- 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']
 

-- 
Repository URL: https://hg.python.org/cpython


More information about the Python-checkins mailing list