comment for assert function

cihai · May 28, 2017 · 095041e · 095041e
1 parent 5e186c6
commit 095041e
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/unihan_etl/test.py b/unihan_etl/test.py
@@ -6,6 +6,15 @@
 
 
 def assert_dict_contains_subset(subset, dictionary, msg=None):
+    """Ported assertion for dict subsets in py.test.
+
+    :param subset: needle
+    :type subset: dict
+    :param dictionary: haystack
+    :type dictionary: dict
+    :param msg: message for assert if failure found
+    :type msg: str
+    """
     for key, value in subset.items():
         assert key in dictionary, msg
         assert dictionary[key] == value, msg