chore: add docstring for base_model

Deltares · Jul 22, 2024 · 51a1a2b · 51a1a2b
1 parent 9b098be
commit 51a1a2b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/geolib/models/base_model.py b/geolib/models/base_model.py
@@ -38,6 +38,12 @@
 class BaseModel(BaseDataClass, abc.ABC):
     filename: Optional[Path] = None
     datastructure: Optional[SerializeAsAny[BaseModelStructure]] = None
+    """
+    This is the base class for all models in GEOLib.
+    
+    Note that `datastructure` is a `SerializeAsAny` type, which means that
+    the inheriting class is serialized according to its own definition.
+    """
 
     def execute(self, timeout_in_seconds: int = meta.timeout) -> "BaseModel":
         """Execute a Model and wait for `timeout` seconds.