Add schema docs.

pnnl · Oct 27, 2023 · 5da064d · 5da064d
1 parent a7af978
commit 5da064d
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/copper/schema.py b/copper/schema.py
@@ -35,9 +35,15 @@ def __init__(self, input):
         self.validator = Validator(self.schema, resolver=self.resolver)
 
     def validate(self):
+        """Validate input file to be used in the CLI.
+
+        :return: Result of the validation
+        :rtype: bool
+
+        """
         try:
             self.validator.validate(self.input)
             return True
         except:
             logging.critical("Input file is not valid.")
-            return
+            return False
diff --git a/docs/source/Code Documentation.rst b/docs/source/Code Documentation.rst
@@ -26,3 +26,8 @@ Code Documentation
     :inherited-members:
     :undoc-members:
     :show-inheritance:
+.. automodule:: copper.schema
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/tests/test_schema.py b/tests/test_schema.py
@@ -12,5 +12,5 @@ def test_bad_schema(self):
         input_file = json.load(open("./tests/data/cli_input_file.json", "r"))
         input_file["actions"][0]["function_call"]["vars"] = 42.0
         with self.assertLogs() as captured:
-            assert cp.Schema(input=input_file).validate() is None
+            assert cp.Schema(input=input_file).validate()
             self.assertTrue(captured[0][0].msg == "Input file is not valid.")