update documentation for validation_and_statistics

SDM-TIB · Sep 3, 2024 · 6a0353e · 6a0353e
1 parent ce9b541
commit 6a0353e
Showing 1 changed file with 19 additions and 11 deletions.
diff --git a/shaclapi/api.py b/shaclapi/api.py
@@ -329,22 +329,30 @@ def validation_and_statistics(pre_config):
     used to optimize the validation performance.
 
     Returns
-    -------
-        JSON structure:
-        {shape1:
-            {valid: #valid instances,
-            invalid: #invalid instances,
-            columns: [column name 1, column name 2, ...],
-            results: [[instance 1 data 1,instance 1 data 2, ...], [instance 2 data 1,instance 2 data 2, ...], ...]
-            }
-        shape2: {...}
-        ...
-        }
     -------
     dict
        The result includes per-shape counts of the valid and invalid instances as
        well as a Boolean per instance of the shape stating its satisfaction of the
        shape's constraints.
+       JSON structure:
+
+       .. code-block:: none
+
+          {
+              shape1: {
+                  valid: #valid instances,
+                  invalid: #invalid instances,
+                  columns: [column name 1, column name 2, ...],
+                  results: [
+                      [instance 1 data 1,instance 1 data 2, ...],
+                      [instance 2 data 1,instance 2 data 2, ...],
+                      ...
+                  ]
+              },
+              shape2: {...},
+              ...
+          }
+
     """
     from multiprocessing import Queue
     config = Config.from_request_form(pre_config)