Added example into "denormalize" function's docstring

evo-company · Sep 22, 2016 · 31961ea · 31961ea
1 parent a515acf
commit 31961ea
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/hiku/result.py b/hiku/result.py
@@ -107,6 +107,13 @@ def denormalize(graph, result, query):
 
     This hierarchical structure will follow query structure.
 
+    Example::
+
+        query = hiku.readers.simple.read('[:foo]')
+        norm_result = hiku_engine.execute(graph, query)
+        result = hiku.result.denormalize(graph, norm_result, query)
+        assert result == {'foo': 'value'}
+
     :param graph: :py:class:`~hiku.graph.Graph` definition
     :param result: result of the query
     :param query: executed query, instance of the :py:class:`~hiku.query.Edge`