fix: align parameter formatting in multiple usage documentation files for consistency

Author: FabrizioMusacchio

docs/source/usage_batch_conversion.rst

@@ -174,7 +174,7 @@ default), no folder-stack discovery is performed.
       folder_stacks     = ("FOV1",),
       merge_along_axis  = "T",
       zeropadding       = True,
-      output_folder_name = "omio_converted_FOV1",
+      output_folder_name= "omio_converted_FOV1",
       verbose           = True)
 
 In this example, OMIO searches each final ``TP005`` folder for child folders whose
@@ -248,10 +248,10 @@ the root error report contains an editable Python dictionary named
 .. code-block:: python
 
    result = om.batch_create_thorlabs_raw_yaml_templates(
-       project_root="my_project",
-       report_name="omio_batch_error_report_2026-08-20_12-00-00.txt",
-       overwrite_existing=False,
-       verbose=True)
+       project_root       = "my_project",
+       report_name        = "omio_batch_error_report_2026-08-20_12-00-00.txt",
+       overwrite_existing = False,
+       verbose            = True)
 
    print(f"Created YAML templates: {len(result.created)}")
    print(f"Skipped RAW files:      {len(result.skipped)}")

docs/source/usage_core_functions.rst

@@ -229,9 +229,9 @@ You can also specify custom layer names for each channel in the image:
 .. code-block:: python
 
    om.open_in_napari(image, metadata, 
-                     image_name="my image",
-                     layer_names=["channel 0", "channel 1", "channel 2"],
-                     blending="additive")
+                     image_name  = "my image",
+                     layer_names = ["channel 0", "channel 1", "channel 2"],
+                     blending    = "additive")
 
 For demonstration purposes, we change the ``PhysicalSizeZ`` metadata entry to an
 incorrect value and re-open the image in Napari to see that Napari correctly rescales

docs/source/usage_large_files.rst

@@ -83,8 +83,8 @@ creates ``.omio_cache``:
 
    image_local_cache, metadata_local_cache = om.imread(
        fname,
-       zarr_store="disk",
-       zarr_store_path=local_cache_root)
+       zarr_store      = "disk",
+       zarr_store_path = local_cache_root)
 
    print(metadata_local_cache["omio_cache_folder"])
    print(metadata_local_cache["omio_zarr_store_path"])

docs/source/usage_template_functions.rst

@@ -34,9 +34,9 @@ as arguments:
 .. code-block:: python
 
    my_image, my_metadata = om.create_empty_image(
-       shape=(5, 10, 512, 512),
-       dtype=np.uint16,
-       return_metadata=True)
+       shape            = (5, 10, 512, 512),
+       dtype            = np.uint16,
+       return_metadata  = True)
 
    print(f"Failed to create empty image. Type of my_image is {type(my_image)} "
          f"and of my_metadata {type(my_metadata)}.")
@@ -53,9 +53,9 @@ and return ``None`` for both image and metadata.
 .. code-block:: python
 
    my_image, my_metadata = om.create_empty_image(
-       shape=(5, 20, 2, 512, 512),
-       dtype=np.uint16,
-       return_metadata=True)
+       shape            = (5, 20, 2, 512, 512),
+       dtype            = np.uint16,
+       return_metadata  = True)
 
    print(f"Created empty image with shape: {my_image.shape}, "
          f"dtype {my_image.dtype} and axes {my_metadata.get('axes', 'N/A')}.")
@@ -152,12 +152,12 @@ paths in the returned metadata.
    zarr_parent = "example_data/custom_created_images/"
 
    my_zarr_image, my_zarr_metadata = om.create_empty_image(
-       shape=(5, 20, 2, 512, 512),
-       dtype=np.uint16,
-       zarr_store="disk",
-       zarr_store_path=zarr_parent,
-       zarr_store_name="my_empty_image_zarr",
-       return_metadata=True)
+       shape            = (5, 20, 2, 512, 512),
+       dtype            = np.uint16,
+       zarr_store       = "disk",
+       zarr_store_path  = zarr_parent,
+       zarr_store_name  = "my_empty_image_zarr",
+       return_metadata  = True)
 
    print(f"Created disk-backed Zarr image with shape: {my_zarr_image.shape}")
    print(f"Zarr store path: {my_zarr_metadata['omio_zarr_store_path']}")