update docstrings

bioimage-io · Nov 12, 2024 · 428407b · 428407b
1 parent 291e33b
commit 428407b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/bioimageio_collection_backoffice/common.py b/bioimageio_collection_backoffice/common.py
@@ -10,4 +10,6 @@ class Node(
     validate_assignment=True,
     validate_default=False,
 ):
+    """"""  # avoid inheriting docstring from `pydantic.BaseModel`
+
     pass
diff --git a/bioimageio_collection_backoffice/db_structure/compatibility.py b/bioimageio_collection_backoffice/db_structure/compatibility.py
@@ -8,6 +8,10 @@
 
 
 class CompatibilityReport(Node, frozen=True, extra="allow"):
+    """Used to report on the compatibility of resource description
+    in the bioimageio collection
+    """
+
     tool: Annotated[str, Field(exclude=True, pattern=r"^[^_]+_[^_]+$")]
     """toolname (including version separated by an underscore)"""