Fix RST syntax. Add hierarchy to toctree.

open-contracting · Mar 13, 2020 · 95e88b5 · 95e88b5
1 parent 9116c55
commit 95e88b5
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 8 deletions.
diff --git a/docs/api/testing/index.rst b/docs/api/testing/index.rst
@@ -0,0 +1,9 @@
+Testing
+=======
+
+.. toctree::
+
+   checks
+   schema
+   filesystem
+   util
diff --git a/docs/index.rst b/docs/index.rst
@@ -7,12 +7,8 @@ API
 ---
 
 .. toctree::
-   :maxdepth: 2
 
-   api/testing/checks
-   api/testing/schema
-   api/testing/filesystem
-   api/testing/util
+   api/testing/index
    api/exceptions
 
 Copyright (c) 2020 Open Contracting Partnership and Open Data Services Co-operative Limited, released under the BSD license
diff --git a/jscc/testing/checks.py b/jscc/testing/checks.py
@@ -451,9 +451,9 @@ def validate_object_id(*args, allow_missing=(), allow_optional=()):
     Warns and returns the number of errors relating to objects within arrays lacking "id" fields.
 
     :param allow_missing: JSON Pointers of fields that are allowed to not have an "id" field
-    :type : list, tuple or set
+    :type allow_missing: list, tuple or set
     :param allow_optional: JSON Pointers of fields whose "id" field is allowed to be optional
-    :type : list, tuple or set
+    :type allow_optional: list, tuple or set
     """
     def block(path, data, pointer):
         errors = 0
@@ -528,7 +528,7 @@ def block(path, data, pointer):
 
 def validate_ref(path, data):
     """
-    Warns and returns ``1`` if not all ``$ref``erences can be resolved.
+    Warns and returns ``1`` if not all ``$ref``'erences can be resolved.
     """
     ref = JsonRef.replace_refs(data)