From 2e6cc7bc29ff524c2015dfbfbc06d36db1f49178 Mon Sep 17 00:00:00 2001 From: David Stansby Date: Wed, 27 Nov 2024 22:10:48 +0000 Subject: [PATCH] Add docstring --- src/ome_zarr_models/v04/image.py | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/src/ome_zarr_models/v04/image.py b/src/ome_zarr_models/v04/image.py index 1d5832a..35fea8c 100644 --- a/src/ome_zarr_models/v04/image.py +++ b/src/ome_zarr_models/v04/image.py @@ -14,7 +14,7 @@ # Image is imported to the `ome_zarr_py.v04` namespace, so not # listed here -__all__ = ["ImageAttrs", "Image"] +__all__ = ["Image", "ImageAttrs"] def _check_arrays_compatible(data: Image) -> Image: @@ -85,7 +85,12 @@ class _ImageSpec(GroupSpec[ImageAttrs, ArraySpec | GroupSpec]): class Image: """ - An OME-zarr multiscale dataset. + A multiscale zarr group. + + Parameters + ---------- + group : + Group to create object from. """ def __init__(self, group: zarr.Group) -> None: