From a2195e5d691a2025b6df376102f17fc5056e394a Mon Sep 17 00:00:00 2001 From: Sebastien Besson Date: Thu, 16 Dec 2021 07:21:43 +0000 Subject: [PATCH] Improve docstrings --- ome_zarr/writer.py | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/ome_zarr/writer.py b/ome_zarr/writer.py index 7833faa1..0e94a467 100644 --- a/ome_zarr/writer.py +++ b/ome_zarr/writer.py @@ -116,20 +116,20 @@ def write_multiscales_metadata( axes: List[str] = None, ) -> None: """ - Write the multiscales metadata in the group metadata + Write the multiscales metadata in the group. Parameters ---------- group: zarr.Group - the group within the zarr store to store the data in - paths: list of str, - The list of path to the datasets for this multiscale image + the group within the zarr store to write the metadata in. + paths: list of str + The list of paths to the datasets for this multiscale image. fmt: Format The format of the ome_zarr data which should be used. Defaults to the most current. - axes: str or list of str - the names of the axes. e.g. "tczyx". Not needed for v0.1 or v0.2 - or for v0.3 if 2D or 5D. Otherwise this must be provided + axes: list of str + the names of the axes. e.g. ["t", "c", "z", "y", "x"]. + Ignored for versions 0.1 and 0.2. Required for version 0.3 or greater. """ multiscales = [