Merge pull request #5917 from knelli2/clarify_py_multiple_opts

Clarify use of 'multiple' options in some CLI functions

src/IO/H5/Python/DeleteSubfiles.py

@@ -27,7 +27,10 @@
     "subfiles",
     required=True,
     multiple=True,
-    help="Subfile to delete",
+    help=(
+        "Subfile to delete. Can be specified multiple times to delete many"
+        " subfiles at once."
+    ),
 )
 @click.option(
     "--repack/--no-repack",

src/IO/H5/Python/ExtractDatFromH5.py

@@ -166,7 +166,11 @@ def extract_dat_files(
     "-d",
     "subfiles",
     multiple=True,
-    help="Full path of subfile to extract (including extension).",
+    help=(
+        "Full path of subfile to extract (including extension). Can be"
+        " specified multiple times to extract several subfiles at once. If"
+        " unspecified, all subfiles will be extracted."
+    ),
 )
 def extract_dat_command(**kwargs):
     _rich_traceback_guard = True  # Hide traceback until here

src/Visualization/Python/InterpolateToMesh.py

@@ -226,11 +226,12 @@ def interpolate_to_mesh(
 @click.option(
     "--tensor-component",
     "-t",
+    "tensor_components",
     multiple=True,
     help=(
-        "The names of the tensors that are to be interpolated. "
-        "Accepts regular expression. "
-        "If none are specified, all tensors are interpolated."
+        "The name of the tensor to be interpolated. Accepts regular"
+        " expression. Can be specified multiple times to interpolate several"
+        " tensors at once. If none are specified, all tensors are interpolated."
     ),
 )
 @click.option(
@@ -296,7 +297,7 @@ def interpolate_to_mesh_command(
     target_extents,
     target_basis,
     target_quadrature,
-    tensor_component,
+    tensor_components,
     start_time,
     stop_time,
     stride,
@@ -332,7 +333,7 @@ def interpolate_to_mesh_command(
                 target_file_path=target_file_path,
                 source_volume_data=source_subfile_name,
                 target_volume_data=target_subfile_name,
-                components_to_interpolate=tensor_component,
+                components_to_interpolate=tensor_components,
                 obs_start=start_time,
                 obs_end=stop_time,
                 obs_stride=stride,

src/Visualization/Python/PlotDatFile.py

@@ -66,13 +66,18 @@ def parse_functions(ctx, param, all_values):
     help="Print out the available quantities and exit.",
 )
 @click.option(
-    "--functions",
+    "--function",
     "-y",
+    "functions",
     multiple=True,
     callback=parse_functions,
     help=(
-        "The quantities to plot. If unspecified, list all available "
-        "quantities and exit."
+        "The quantity to plot. Can be specified multiple times to plot several"
+        " quantities on a single figure. If unspecified, list all available"
+        " quantities and exit. Labels of quantities can be specified as"
+        " key-value pairs such as 'Error(Psi)=$L_2(\\psi)$'. Remember to wrap"
+        " the key-value pair in quotes on the command line to avoid issues with"
+        " special characters or spaces."
     ),
 )
 @click.option(

src/Visualization/Python/PlotPowerMonitors.py

@@ -274,8 +274,8 @@ def plot_power_monitors(
     "block_or_group_names",
     multiple=True,
     help=(
-        "Names of blocks or block groups to analyze. "
-        "Can be specified multiple times."
+        "Name of block or block group to analyze. "
+        "Can be specified multiple times to plot several block(groups) at once."
     ),
 )
 @click.option(
@@ -288,7 +288,7 @@ def plot_power_monitors(
         "pattern, like 'B*,(L1I*,L0I0,L0I0)'. "
         "Can be specified multiple times, in which case elements "
         "are included that match _any_ of the specified "
-        "patterns."
+        "patterns. If unspecified, include all elements in the blocks."
     ),
 )
 @click.option(

src/Visualization/Python/TransformVolumeData.py

@@ -664,12 +664,12 @@ def parse_kernels(kernels, exec_files, map_input_names):
     "kernels",
     multiple=True,
     help=(
-        "Python function(s) to apply to the volume data. "
+        "Python function to apply to the volume data. "
         "Specify as 'path.to.module.function_name', where the "
         "module must be available to import. "
         "Alternatively, specify just 'function_name' if the "
         "function is defined in one of the '--exec' / '-e' "
-        "files."
+        "files. Can be specified multiple times."
     ),
 )
 @click.option(
@@ -679,9 +679,9 @@ def parse_kernels(kernels, exec_files, map_input_names):
     type=click.File("r"),
     multiple=True,
     help=(
-        "Python file(s) to execute before loading kernels. "
-        "Load kernels from these files with the '--kernel' / '-k' "
-        "option."
+        "Python file to execute before loading kernels. "
+        "Load kernels from this file with the '--kernel' / '-k' "
+        "option. Can be specified multiple times."
     ),
 )
 @click.option(
@@ -691,10 +691,10 @@ def parse_kernels(kernels, exec_files, map_input_names):
     multiple=True,
     callback=parse_input_names,
     help=(
-        "Map of function argument names to dataset names "
-        "in the volume data file. Specify key-value pairs "
-        "like 'spatial_metric=SpatialMetric'. If unspecified, "
-        "the argument name is transformed to CamelCase."
+        "Map of function argument name to dataset name in the volume data file."
+        " Specify key-value pair like 'spatial_metric=SpatialMetric'. Can be"
+        " specified multiple times. If unspecified, the argument name is"
+        " transformed to CamelCase."
     ),
 )
 @click.option(

support/Python/Schedule.py

@@ -955,7 +955,7 @@ def wrapper(*args, **kwargs):
     multiple=True,
     callback=_parse_params,
     help=(
-        "Forward additional parameters to input file "
+        "Forward an additional parameter to the input file "
         "and submit script templates. "
         "Can be specified multiple times. "
         "Each entry must be a 'key=value' pair, where the key is "