📝 docstrings

pyodmongo/models/responses.py

@@ -3,6 +3,19 @@
 
 
 class DbResponse(BaseModel):
+    """
+    A class representing the response from database operations.
+
+    Attributes:
+        acknowledged (bool): Whether the operation was acknowledged by the server.
+        deleted_count (int): The number of documents deleted.
+        inserted_count (int): The number of documents inserted.
+        matched_count (int): The number of documents matched by the query.
+        modified_count (int): The number of documents modified.
+        upserted_count (int): The number of documents upserted (inserted or replaced).
+        upserted_ids (dict[int, Id]): A dictionary mapping index to the upserted document IDs.
+    """
+
     acknowledged: bool
     deleted_count: int
     inserted_count: int

pyodmongo/services/verify_subclasses.py

@@ -2,13 +2,32 @@
 from types import NoneType
 
 
-def _rec_verify(class_list: list):
+def _rec_verify(class_list: list) -> list:
+    """
+    Recursively verify the class hierarchy and extend the class list with base classes.
+
+    Args:
+        class_list (list): A list of classes to be verified.
+
+    Returns:
+        list: The extended list of classes including all base classes.
+    """
     for cls in class_list:
         class_list += list(cls.__bases__)
     return class_list
 
 
-def is_subclass(class_to_verify: Any, subclass: Any):
+def is_subclass(class_to_verify: Any, subclass: Any) -> bool:
+    """
+    Check if the class_to_verify is a subclass of the given subclass.
+
+    Args:
+        class_to_verify (Any): The class to be verified.
+        subclass (Any): The subclass to check against.
+
+    Returns:
+        bool: True if class_to_verify is a subclass of subclass, otherwise False.
+    """
     if class_to_verify is NoneType:
         return True
     if (