Fix docstrings

Author: CBroz1

element_array_ephys/ephys_acute.py

@@ -718,15 +718,18 @@ class ClusteringTask(dj.Manual):
     """
 
     @classmethod
-    def infer_output_dir(cls, key: dict, relative: bool = False, mkdir: bool = False):
+    def infer_output_dir(
+        cls, key: dict, relative: bool = False, mkdir: bool = False
+    ) -> pathlib.Path:
         """Infer output directory if it is not provided.
 
         Args:
             key (dict): ClusteringTask primary key.
 
         Returns:
-            Pathlib.Path: Expected clustering_output_dir based on the following convention: processed_dir / session_dir / probe_{insertion_number} / {clustering_method}_{paramset_idx}
-            e.g.: sub4/sess1/probe_2/kilosort2_0
+            Expected clustering_output_dir based on the following convention:
+                processed_dir / session_dir / probe_{insertion_number} / {clustering_method}_{paramset_idx}
+                e.g.: sub4/sess1/probe_2/kilosort2_0
         """
         processed_dir = pathlib.Path(get_processed_root_data_dir())
         session_dir = find_full_path(
@@ -1325,7 +1328,7 @@ class Waveform(dj.Part):
             recovery_slope (float): Slope of the regression line fit to first 30 microseconds from peak to tail.
             spread (float): The range with amplitude over 12-percent of maximum amplitude along the probe.
             velocity_above (float): inverse velocity of waveform propagation from soma to the top of the probe.
-            velocity_below (float) inverse velocity of waveform propagation from soma toward the bottom of the probe.
+            velocity_below (float): inverse velocity of waveform propagation from soma toward the bottom of the probe.
         """
 
         definition = """

element_array_ephys/ephys_chronic.py

@@ -651,15 +651,16 @@ class ClusteringTask(dj.Manual):
     """
 
     @classmethod
-    def infer_output_dir(cls, key, relative=False, mkdir=False):
+    def infer_output_dir(cls, key, relative=False, mkdir=False) -> pathlib.Path:
         """Infer output directory if it is not provided.
 
         Args:
             key (dict): ClusteringTask primary key.
 
         Returns:
-            Pathlib.Path: Expected clustering_output_dir based on the following convention: processed_dir / session_dir / probe_{insertion_number} / {clustering_method}_{paramset_idx}
-            e.g.: sub4/sess1/probe_2/kilosort2_0
+            Expected clustering_output_dir based on the following convention:
+                processed_dir / session_dir / probe_{insertion_number} / {clustering_method}_{paramset_idx}
+                e.g.: sub4/sess1/probe_2/kilosort2_0
         """
         processed_dir = pathlib.Path(get_processed_root_data_dir())
         sess_dir = find_full_path(get_ephys_root_data_dir(), get_session_directory(key))
@@ -1256,7 +1257,7 @@ class Waveform(dj.Part):
             recovery_slope (float): Slope of the regression line fit to first 30 microseconds from peak to tail.
             spread (float): The range with amplitude over 12-percent of maximum amplitude along the probe.
             velocity_above (float): inverse velocity of waveform propagation from soma to the top of the probe.
-            velocity_below (float) inverse velocity of waveform propagation from soma toward the bottom of the probe.
+            velocity_below (float): inverse velocity of waveform propagation from soma toward the bottom of the probe.
         """
 
         definition = """

element_array_ephys/ephys_no_curation.py

@@ -614,7 +614,7 @@ class ClusteringParamSet(dj.Lookup):
         ClusteringMethod (dict): ClusteringMethod primary key.
         paramset_desc (varchar(128) ): Description of the clustering parameter set.
         param_set_hash (uuid): UUID hash for the parameter set.
-        params (longblob)
+        params (longblob): Set of clustering parameters
     """
 
     definition = """
@@ -724,15 +724,18 @@ class ClusteringTask(dj.Manual):
     """
 
     @classmethod
-    def infer_output_dir(cls, key, relative: bool = False, mkdir: bool = False):
+    def infer_output_dir(
+        cls, key, relative: bool = False, mkdir: bool = False
+    ) -> pathlib.Path:
         """Infer output directory if it is not provided.
 
         Args:
             key (dict): ClusteringTask primary key.
 
         Returns:
-            Pathlib.Path: Expected clustering_output_dir based on the following convention: processed_dir / session_dir / probe_{insertion_number} / {clustering_method}_{paramset_idx}
-            e.g.: sub4/sess1/probe_2/kilosort2_0
+            Expected clustering_output_dir based on the following convention:
+                processed_dir / session_dir / probe_{insertion_number} / {clustering_method}_{paramset_idx}
+                e.g.: sub4/sess1/probe_2/kilosort2_0
         """
         processed_dir = pathlib.Path(get_processed_root_data_dir())
         session_dir = find_full_path(
@@ -1265,7 +1268,7 @@ class Waveform(dj.Part):
             recovery_slope (float): Slope of the regression line fit to first 30 microseconds from peak to tail.
             spread (float): The range with amplitude over 12-percent of maximum amplitude along the probe.
             velocity_above (float): inverse velocity of waveform propagation from soma to the top of the probe.
-            velocity_below (float) inverse velocity of waveform propagation from soma toward the bottom of the probe.
+            velocity_below (float): inverse velocity of waveform propagation from soma toward the bottom of the probe.
         """
 
         definition = """

element_array_ephys/ephys_precluster.py

@@ -702,7 +702,7 @@ class ClusteringParamSet(dj.Lookup):
         ClusteringMethod (dict): ClusteringMethod primary key.
         paramset_desc (varchar(128) ): Description of the clustering parameter set.
         param_set_hash (uuid): UUID hash for the parameter set.
-        params (longblob)
+        params (longblob): Paramset, dictionary of all applicable parameters.
     """
 
     definition = """
@@ -723,7 +723,7 @@ def insert_new_params(
         """Inserts new parameters into the ClusteringParamSet table.
 
         Args:
-            clustering_method (str): name of the clustering method.
+            processing_method (str): name of the clustering method.
             paramset_desc (str): description of the parameter set
             params (dict): clustering parameters
             paramset_idx (int, optional): Unique parameter set ID. Defaults to None.
@@ -1245,7 +1245,7 @@ class Waveform(dj.Part):
             recovery_slope (float): Slope of the regression line fit to first 30 microseconds from peak to tail.
             spread (float): The range with amplitude over 12-percent of maximum amplitude along the probe.
             velocity_above (float): inverse velocity of waveform propagation from soma to the top of the probe.
-            velocity_below (float) inverse velocity of waveform propagation from soma toward the bottom of the probe.
+            velocity_below (float): inverse velocity of waveform propagation from soma toward the bottom of the probe.
         """
 
         definition = """