Add docstring for validate()

Metron-Project · Jun 19, 2024 · 69ddcda · 69ddcda
1 parent 2e0660e
commit 69ddcda
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/metrontagger/validate_ci.py b/metrontagger/validate_ci.py
@@ -90,6 +90,13 @@ def _is_valid(self: ValidateComicInfo, schema_version: SchemaVersion) -> bool:
         return xmlschema.validate(xml_doc)
 
     def validate(self: ValidateComicInfo) -> SchemaVersion:
+        """
+        Returns the highest valid schema version based on the given ValidateComicInfo instance.
+
+        Returns:
+            SchemaVersion: The highest valid schema version found.
+        """
+
         return next(
             (
                 schema_version