Docs and a import re-ordering for dict codec

python-odin · Feb 5, 2018 · fa1e36a · fa1e36a
1 parent e16971b
commit fa1e36a
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 1 deletion.
diff --git a/docs/ref/codecs/dict_codec.rst b/docs/ref/codecs/dict_codec.rst
@@ -0,0 +1,26 @@
+##########
+Dict Codec
+##########
+
+Codec for serialising and de-serialising Dictionary and List objects.
+
+.. automodule:: odin.codecs.dict_codec
+
+Methods
+=======
+
+    .. autofunction:: load
+
+    .. autofunction:: dump
+
+
+Example usage
+=============
+
+Loading a resource from a file::
+
+    from odin.codecs import dict_codec
+
+    my_dict = {}
+
+    resource = dict_codec.load(my_dict, MyResource)
diff --git a/odin/codecs/dict_codec.py b/odin/codecs/dict_codec.py
@@ -1,8 +1,8 @@
 import six
-from odin.utils import getmeta
 
 from odin import bases
 from odin import resources, ResourceAdapter
+from odin.utils import getmeta
 
 
 TYPE_SERIALIZERS = {}