[openownership/cove-bods#16] Update docstring

OpenDataServices · Feb 7, 2019 · b3b53b9 · b3b53b9
1 parent a73db38
commit b3b53b9
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/libcove/lib/common.py b/libcove/lib/common.py
@@ -86,7 +86,13 @@ def oneOf_draft4(validator, oneOf, instance, schema):
     """
     oneOf_draft4 validator from
     https://github.com/Julian/jsonschema/blob/d16713a4296663f3d62c50b9f9a2893cb380b7af/jsonschema/_validators.py#L337
-    patched to sort the instance.
+
+    Modified to:
+    - sort the instance JSON, so we get a reproducible output that we
+      can can test more easily
+    - If `statementType` is available, use that pick the correct
+      sub-schema, and to yield those ValidationErrors. (Only
+      applicable for BODS).
     """
     subschemas = enumerate(oneOf)
     all_errors = []