diff --git a/geolib/models/base_model.py b/geolib/models/base_model.py index e629d828..df11601d 100644 --- 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.