Merge pull request #316 from dstansby/clean-format-doc

Minor improvements to format docs
ome · Oct 10, 2023 · 042038c · 042038c
2 parents 9ee5142 + 074287d
commit 042038c
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/ome_zarr/format.py b/ome_zarr/format.py
@@ -45,6 +45,10 @@ def detect_format(metadata: dict, default: "Format") -> "Format":
 
 
 class Format(ABC):
+    """
+    Abstract base class for format implementations.
+    """
+
     @property
     @abstractmethod
     def version(self) -> str:  # pragma: no cover
@@ -275,8 +279,9 @@ def validate_coordinate_transformations(
         """
         Validates that a list of dicts contains a 'scale' transformation
 
-        Raises ValueError if no 'scale' found or doesn't match ndim
-        :param ndim:       Number of image dimensions
+        Raises ValueError if no 'scale' found or doesn't match ndim.
+
+        :param ndim: Number of image dimensions.
         """
 
         if coordinate_transformations is None: