Extend docstring

SpikeInterface · Oct 26, 2023 · 213da0a · 213da0a
1 parent 8c02176
commit 213da0a
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/src/spikeinterface/widgets/gtstudy.py b/src/spikeinterface/widgets/gtstudy.py
@@ -133,8 +133,12 @@ class StudyPerformances(BaseWidget):
     ----------
     study: GroundTruthStudy
         A study object.
-    mode: str
-        Which mode in "ordered", "snr", "swarm"
+    mode: "ordered" | "snr" | "swarm", default: "ordered"
+        Which plot mode to use:
+
+        * "ordered": plot performance metrics vs unit indices ordered by decreasing accuracy (default)
+        * "snr": plot performance metrics vs snr
+        * "swarm": plot performance metrics as a swarm plot (see seaborn.swarmplot for details)
     performance_names: list or tuple, default: ('accuracy', 'precision', 'recall')
         Which performances to plot ("accuracy", "precision", "recall")
     case_keys: list or None