update docstrings

bioimage-io · Nov 29, 2024 · 959380d · 959380d
1 parent 34d5545
commit 959380d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 4 deletions.
diff --git a/bioimageio/spec/_internal/node.py b/bioimageio/spec/_internal/node.py
@@ -38,7 +38,7 @@ class Node(
     use_attribute_docstrings=True,
     model_title_generator=_node_title_generator,
 ):
-    """Subpart of a resource description"""
+    """"""  # empty docstring to remove all pydantic docstrings from the pdoc spec docs
 
     @classmethod
     def model_validate(

diff --git a/bioimageio/spec/model/v0_5.py b/bioimageio/spec/model/v0_5.py
@@ -130,7 +130,6 @@
 from .v0_4 import ZeroMeanUnitVarianceDescr as _ZeroMeanUnitVarianceDescr_v0_4
 from .v0_4 import package_weights
 
-# unit names from https://ngff.openmicroscopy.org/latest/#axes-md
 SpaceUnit = Literal[
     "attometer",
     "angstrom",
@@ -159,6 +158,7 @@
     "zeptometer",
     "zettameter",
 ]
+"""Space unit compatible to the [OME-Zarr axes specification 0.5](https://ngff.openmicroscopy.org/0.5/#axes-md)"""
 
 TimeUnit = Literal[
     "attosecond",
@@ -185,6 +185,7 @@
     "zeptosecond",
     "zettasecond",
 ]
+"""Time unit compatible to the [OME-Zarr axes specification 0.5](https://ngff.openmicroscopy.org/0.5/#axes-md)"""
 
 AxisType = Literal["batch", "channel", "index", "time", "space"]
 
@@ -414,8 +415,6 @@ def _get_unit(
         return axis.unit
 
 
-# this Axis definition is compatible with the NGFF draft from July 10, 2023
-# https://ngff.openmicroscopy.org/latest/#axes-md
 class AxisBase(NodeWithExplicitlySetFields):
     fields_to_set_explicitly: ClassVar[FrozenSet[LiteralString]] = frozenset({"type"})