From f420fae4e3f13125abc3b5339bfdcacd7c655c97 Mon Sep 17 00:00:00 2001
From: Prodesire <prodesire@yeah.net>
Date: Tue, 2 Jan 2018 22:56:00 +0800
Subject: [PATCH] add doc for dict.OrderedDict

---
 docs/dict.rst | 75 ++++++++++++++++++++++++++++++++-------------------
 pydu/dict.py  | 11 ++++++++
 2 files changed, 59 insertions(+), 27 deletions(-)

diff --git a/docs/dict.rst b/docs/dict.rst
index 7b8354e..745e876 100644
--- a/docs/dict.rst
+++ b/docs/dict.rst
@@ -6,19 +6,19 @@ Dict
     A AttrDict object is like a dictionary except ``obj.foo`` can be used
     in addition to ``obj['foo']``.
 
-        >>> from pydu.dict import AttrDict
-        >>> o = AttrDict(a=1)
-        o.a
-        1
-        >>> o['a']
-        1
-        >>> o.a = 2
-        >>> o['a']
-        2
-        >>> del o.a
-        >>> o.a
-        Traceback (most recent call last):
-         ...    AttributeError: 'a'
+    >>> from pydu.dict import AttrDict
+    >>> o = AttrDict(a=1)
+    o.a
+    1
+    >>> o['a']
+    1
+    >>> o.a = 2
+    >>> o['a']
+    2
+    >>> del o.a
+    >>> o.a
+    Traceback (most recent call last):
+     ...    AttributeError: 'a'
 
 
 .. py:class:: pydu.dict.CaseInsensitiveDict(data=None, **kwargs)
@@ -31,26 +31,47 @@ Dict
     ``items()``, ``iterkeys()``, and ``iteritems()`` will contain
     case-sensitive keys.
 
-        >>> from pydu.dict import CaseInsensitiveDict
-        >>> cid = CaseInsensitiveDict()
-        >>> cid['Accept'] = 'application/json'
-        >>> cid['aCCEPT'] == 'application/json'
-        True
-        >>> list(cid) == ['Accept']
-        True
+    >>> from pydu.dict import CaseInsensitiveDict
+    >>> cid = CaseInsensitiveDict()
+    >>> cid['Accept'] = 'application/json'
+    >>> cid['aCCEPT'] == 'application/json'
+    True
+    >>> list(cid) == ['Accept']
+    True
 
 
 .. py:class:: pydu.dict.LookupDict(name=None)
 
     Dictionary lookup object.
 
-        >>> from pydu.dict import LookupDict
-        >>> d = LookupDict()
-        >>> d['key']
-        None
-        >>> d['key'] = 1
-        >>> d['key']
-        1
+    >>> from pydu.dict import LookupDict
+    >>> d = LookupDict()
+    >>> d['key']
+    None
+    >>> d['key'] = 1
+    >>> d['key']
+    1
+
+.. py:class:: pydu.dict.OrderedDefaultDict(default_factory=None, *args, **kwds)
+
+    Dictionary that remembers insertion order and has default value
+    with default factory.
+
+    The default factory is called without arguments to produce
+    a new value when a key is not present, in ``__getitem__`` only.
+    An ``OrderedDefaultDict`` compares equal to a ``collections.defaultdict``
+    with the same items. All remaining arguments are treated the same
+    as if they were passed to the ``defaultdict`` constructor,
+    including keyword arguments.
+
+    >>> from pydu.dict import OrderedDefaultDict
+    >>> d = OrderedDefaultDict(int)
+    >>> d['b']
+    0
+    >>> d['a']
+    0
+    >>> d.keys()
+    odict_keys(['b', 'a'])
 
 
 .. py:function:: pydu.dict.attrify(obj)
diff --git a/pydu/dict.py b/pydu/dict.py
index 7af9ada..26d3569 100644
--- a/pydu/dict.py
+++ b/pydu/dict.py
@@ -133,6 +133,17 @@ class LookupDict(dict):
 
 # https://stackoverflow.com/questions/6190331/can-i-do-an-ordered-default-dict-in-python
 class OrderedDefaultDict(collections.OrderedDict):
+    """
+    Dictionary that remembers insertion order and has default value
+    with default factory.
+
+    The default factory is called without arguments to produce
+    a new value when a key is not present, in `__getitem__` only.
+    An `OrderedDefaultDict` compares equal to a `collections.defaultdict`
+    with the same items. All remaining arguments are treated the same
+    as if they were passed to the `defaultdict` constructor,
+    including keyword arguments.
+    """
     def __init__(self, default_factory=None, *args, **kwds):
         if (default_factory is not None and
            not isinstance(default_factory, collections.Callable)):