Some more docstring reworks

Author: ehrenfeu

src/imcflibs/imagej/bdv.py

@@ -683,8 +683,9 @@ def fmt_acitt_options(self):
         """Format Angle / Channel / Illumination / Tile / Timepoint options.
 
         Build a string providing the `multiple_angles`, `multiple_channels`,
-        `multiple_illuminations_directions`, `multiple_tiles` and `multiple_timepoints` options
-        that can be used in a BDV-related `IJ.run` call.
+        `multiple_illuminations_directions`, `multiple_tiles` and
+        `multiple_timepoints` options that can be used in a BDV-related `IJ.run`
+        call.
 
         Returns
         -------
@@ -708,14 +709,15 @@ def fmt_acitt_options(self):
 def check_processing_input(value, range_end):
     """Sanitize and clarifies the acitt input selection.
 
-    Check if the input is valid by checking the type and returning the expected output.
+    Validate the input by checking the type and returning the expected output.
 
     Parameters
     ----------
     value : str, int, list of int or list of str
-        Contains the list of input dimensions, the first input dimension of a range or a single channel
+        Contains the list of input dimensions, the first input dimension of a
+        range or a single channel.
     range_end : int or None
-        Contains the end of the range if need be
+        Contains the end of the range if need be.
 
     Returns
     -------
@@ -747,10 +749,11 @@ def check_processing_input(value, range_end):
 
 
 def get_processing_settings(dimension, selection, value, range_end):
-    """Get the variables corresponding to the dimension selection and processing mode.
+    """Generate processing strings for selected dimension and processing mode.
 
-    Get the processing option and dimension selection string that corresponds
-    to the selected processing mode.
+    Generate the processing option and dimension selection strings that
+    correspond to the selected processing mode and the given dimension
+    selection.
 
     Parameters
     ----------
@@ -761,14 +764,16 @@ def get_processing_settings(dimension, selection, value, range_end):
         generated string needs to be assembled according to the given dimension
         and value / range settings.
     value : str, int, list of int or list of str
-        Contains the list of input dimensions, the first input dimension of a range or a single channel
+        The list of input dimensions, the first input dimension of a range or a
+        single dimension value in case `selection == "single"` (e.g. for
+        selecting a single channel).
     range_end : int or None
-        Contains the end of the range if need be
+        Contains the end of the range if need be.
 
     Returns
     -------
-    list of str
-        processing options string, dimension selection string
+    tuple of str
+        processing_option, dimension_select
     """
 
     if selection == "single":
@@ -806,9 +811,9 @@ def get_processing_settings(dimension, selection, value, range_end):
 def backup_xml_files(source_directory, subfolder_name):
     """Create a backup of BDV-XML files inside a subfolder of `xml-backup`.
 
-    Copies all `.xml` and `.xml~` files to a subfolder with the given name inside a
-    folder called `xml-backup` in the source directory. Uses the `shutil.copy2()`
-    command, which will overwrite existing files.
+    Copies all `.xml` and `.xml~` files to a subfolder with the given name
+    inside a folder called `xml-backup` in the source directory. Uses the
+    `shutil.copy2()` command, which will overwrite existing files.
 
     Parameters
     ----------
@@ -854,8 +859,8 @@ def define_dataset_auto(
         with an extension.
     dataset_save_path : str
         Output path for the `.xml`.
-    bf_series_type : str
-        One of "Angles" or "Tiles", specifying how Bio-Formats interprets the series.
+    bf_series_type : {`Angles`,`Tiles`}
+        Defines how Bio-Formats interprets the series.
     timepoints_per_partition : int, optional
         Split the output dataset by timepoints. Use `0` for no split, resulting
         in a single HDF5 file containing all timepoints. By default `1`,
@@ -959,8 +964,8 @@ def define_dataset_manual(
     source_directory : str
         Path to the folder containing the file(s).
     image_file_pattern : str
-        Regular expression corresponding to the names of your files and how to read the
-        different dimensions.
+        Regular expression corresponding to the names of your files and how to
+        read the different dimensions.
     dataset_organisation : str
         Organisation of the dataset and the dimensions to process.
         Allows for defining the range of interest of the different dimensions.
@@ -1658,7 +1663,7 @@ def fuse_dataset_bdvp(
 ):
     """Export a BigDataViewer project using the BIOP Kheops exporter.
 
-    This function uses the BIOP Kheops exporter to convert a BigDataViewer project into a
+    Use the BIOP Kheops exporter to convert a BigDataViewer project into
     OME-TIFF files, with optional compression.
 
     Parameters
@@ -1668,11 +1673,11 @@ def fuse_dataset_bdvp(
     command : CommandService
         The Scijava CommandService instance to execute the export command.
     processing_opts : ProcessingOptions, optional
-        Options defining which parts of the dataset to process. If None, default processing
-        options will be used (process all angles, channels, etc.).
+        Options defining which parts of the dataset to process. If None, default
+        processing options will be used (process all angles, channels, etc.).
     result_path : str, optional
-        Path where to store the exported files. If None, files will be saved in the same
-        directory as the input project.
+        Path where to store the exported files. If None, files will be saved in
+        the same directory as the input project.
     compression : str, optional
         Compression method to use for the TIFF files. Default is "LZW".