Merge pull request #95 from niaid/docs_cmd_line

Update command line docs to current utilities
niaid · Feb 7, 2024 · ed278b0 · ed278b0
2 parents c3c7f74 + 1e4e44b
commit ed278b0
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 8 deletions.
diff --git 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
@@ -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
@@ -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):