enh: make recipe titles more verbose

GuckLab · Nov 29, 2023 · 45a9833 · 45a9833
1 parent a7d0109
commit 45a9833
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 4 deletions.
diff --git a/mpl_data_cast/cli/cli.py b/mpl_data_cast/cli/cli.py
@@ -20,7 +20,7 @@ def list_recipes():
     for rec in recipes:
         cls = mpldc_recipe.map_recipe_name_to_class(rec)
         col1 = rec + (" " * (col1len - len(rec)))
-        doc = cls.__doc__.split("\n")[0]
+        doc = cls.__doc__.strip().split("\n")[0]
         click.secho(f"{col1} {doc}")
 
 

diff --git a/mpl_data_cast/mod_recipes/rcp_catchall.py b/mpl_data_cast/mod_recipes/rcp_catchall.py
@@ -6,7 +6,7 @@
 
 
 class CatchAllRecipe(Recipe):
-    """Copy all files, except known junk files"""
+    """Just copy all files, except known junk files"""
 
     def convert_dataset(self, path_list, temp_path, **kwargs):
         """Create a symlink and if that fails, copy the file"""

diff --git a/mpl_data_cast/mod_recipes/rcp_rtdc.py b/mpl_data_cast/mod_recipes/rcp_rtdc.py
@@ -6,7 +6,10 @@
 
 
 class RTDCRecipe(Recipe):
-    """Compress RT-DC data and append SoftwareSettings.ini to logs"""
+    __doc__ = f"""
+    Compress DC data and include .ini files (dclab {dclab.__version__})
+    """
+
     def convert_dataset(self, path_list, temp_path, **kwargs):
         """Compress the dataset using dclab and append SoftwareSettings.ini"""
         # first compress the .rtdc file
@@ -27,7 +30,7 @@ def get_raw_data_iterator(self):
             # search for matching SoftwareSettings.ini files
             if pp.name.startswith("M"):
                 pini = pp.with_name(
-                    pp.name.split("_")[0]+"_SoftwareSettings.ini")
+                    pp.name.split("_")[0] + "_SoftwareSettings.ini")
                 if pini.exists():
                     path_list.append(pini)
             yield path_list