Merge pull request #3360 from h-mayorquin/improve_docstring_of_ground…

…_truth_comparison

Clarify meaning of `delta_time` in  `compare_sorter_to_ground_truth`

src/spikeinterface/comparison/paircomparisons.py

@@ -224,7 +224,9 @@ class GroundTruthComparison(BasePairSorterComparison):
     tested_name : : str, default: None
         The name of sorter 2
     delta_time : float, default: 0.4
-        Number of ms to consider coincident spikes
+        Number of ms to consider coincident spikes.
+        This means that two spikes are considered simultaneous if they are within `delta_time` of each other or
+        mathematically abs(spike1_time - spike2_time) <= delta_time.
     match_score : float, default: 0.5
         Minimum agreement score to match units
     chance_score : float, default: 0.1

src/spikeinterface/sorters/runsorter.py

@@ -272,7 +272,9 @@ def run_sorter_local(
     # only classmethod call not instance (stateless at instance level but state is in folder)
     folder = SorterClass.initialize_folder(recording, folder, verbose, remove_existing_folder)
     SorterClass.set_params_to_folder(recording, folder, sorter_params, verbose)
+    # This writes parameters and recording to binary and could ideally happen in the host
     SorterClass.setup_recording(recording, folder, verbose=verbose)
+    # This NEEDS to happen in the docker because of dependencies
     SorterClass.run_from_folder(folder, raise_error, verbose)
     if with_output:
         sorting = SorterClass.get_result_from_folder(folder, register_recording=True, sorting_info=True)