Update validate doc string

networktocode · Mar 1, 2021 · 01297dc · 01297dc
1 parent 622feea
commit 01297dc
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/schema_enforcer/schemas/validator.py b/schema_enforcer/schemas/validator.py
@@ -43,7 +43,17 @@ def clear_results(self):
         self._results = []
 
     def validate(self, data: dict, strict: bool):
-        """Required function for custom validator."""
+        """Required function for custom validator.
+
+        Args:
+          data (dict): variables to be validated by validator
+          strict (bool): true when --strict cli option is used to request strict validation (if provided)
+
+        Returns:
+          None
+
+        Use add_validation_error and add_validation_pass to report results.
+        """
         raise NotImplementedError