From 1e4e44bf170f8adfbc7702f25883e231fa0dd87f Mon Sep 17 00:00:00 2001 From: Bradley Lowekamp Date: Wed, 7 Feb 2024 10:50:34 -0500 Subject: [PATCH] Update command line docs to current utilities --- docs/api.rst | 1 - docs/commandline.rst | 11 +++++++---- pytools/HedwigZarrImage.py | 4 +--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index f9535d3..c85409e 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,7 +1,6 @@ API === - .. automodule:: pytools :members: diff --git a/docs/commandline.rst b/docs/commandline.rst index aaa581d..2d98c68 100644 --- a/docs/commandline.rst +++ b/docs/commandline.rst @@ -5,17 +5,20 @@ The Pytools packages contain a command line executables for various tasks. They .. code-block :: bash - mrc2nifti --help + zarr_rechunk --help Or the preferred way using the `python` executable to execute the module entry point: .. code-block :: bash - python -m mrc2nifti --help + python -m zarr_rechunk --help With either method of invoking the command line interface, the following sections describes the sub-commands available and the command line options available. -.. click:: pytools.ng.mrc2nifti:main - :prog: mrc2nifti +.. click:: pytools.zarr_rechunk:main + :prog: zarr_rechunk + +.. click:: pytools.zarr_info:main + :prog: zarr_info diff --git a/pytools/HedwigZarrImage.py b/pytools/HedwigZarrImage.py index f452e78..e57a01d 100644 --- a/pytools/HedwigZarrImage.py +++ b/pytools/HedwigZarrImage.py @@ -28,9 +28,7 @@ class HedwigZarrImage: """ - Represents a OME-NGFF Zarr pyramidal image. - - The member provide information useful for the Hedwig imaging pipelines. + Represents a OME-NGFF Zarr pyramidal image. The members provide information useful for the Hedwig imaging pipelines. """ def __init__(self, zarr_grp: zarr.Group, _ome_info: OMEInfo, _ome_idx: int):