update unit_colors docstring EVERYWHERE

Author: chrishalcrow

src/spikeinterface/widgets/all_amplitudes_distributions.py

@@ -19,8 +19,9 @@ class AllAmplitudesDistributionsWidget(BaseWidget):
         The SortingAnalyzer
     unit_ids : list
         List of unit ids, default None
-    unit_colors : None or dict
-        Dict of colors with key : unit, value : color, default None
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     """
 
     def __init__(

src/spikeinterface/widgets/amplitudes.py

@@ -23,8 +23,8 @@ class AmplitudesWidget(BaseRasterWidget):
     unit_ids : list or None, default: None
         List of unit ids
     unit_colors : dict | None, default: None
-        Dict of colors with key : unit, value : color. If None, uses `get_some_colors` to
-        generate colors.
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     segment_index : int or None, default: None
         The segment index (or None if mono-segment)
     max_spikes_per_unit : int or None, default: None

src/spikeinterface/widgets/crosscorrelograms.py

@@ -31,8 +31,9 @@ class CrossCorrelogramsWidget(BaseWidget):
         this argument is ignored
     hide_unit_selector : bool, default: False
         For sortingview backend, if True the unit selector is not displayed
-    unit_colors : dict or None, default: None
-        If given, a dictionary with unit ids as keys and colors as values
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     """
 
     def __init__(

src/spikeinterface/widgets/metrics.py

@@ -24,8 +24,9 @@ class MetricsBaseWidget(BaseWidget):
         If given, a list of quality metrics to skip, default: None
     include_metrics: list or None, default: None
         If given, a list of quality metrics to include, default: None
-    unit_colors :  dict or None, default: None
-        If given, a dictionary with unit ids as keys and colors as values
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     hide_unit_selector : bool, default: False
         For sortingview backend, if True the unit selector is not displayed
     include_metrics_data : bool, default: True

src/spikeinterface/widgets/quality_metrics.py

@@ -18,8 +18,9 @@ class QualityMetricsWidget(MetricsBaseWidget):
         If given, a list of quality metrics to include
     skip_metrics : list or None, default: None
         If given, a list of quality metrics to skip
-    unit_colors : dict or None, default: None
-        If given, a dictionary with unit ids as keys and colors as values
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     hide_unit_selector : bool, default: False
         For sortingview backend, if True the unit selector is not displayed
     """

src/spikeinterface/widgets/rasters.py

@@ -30,8 +30,8 @@ class BaseRasterWidget(BaseWidget):
     scatter_decimate : int | None, default: None
         If equal to n, each nth spike is kept for plotting.
     unit_colors : dict | None, default: None
-        Dict of colors with key : unit, value : color. If None, uses `get_some_colors` to
-        generate colors.
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     color_kwargs : dict | None, default: None
         More color control for e.g. colouring spikes by property. Passed to `maplotlib.scatter`.
     plot_legend : bool, default: False

src/spikeinterface/widgets/spike_locations.py

@@ -23,8 +23,9 @@ class SpikeLocationsWidget(BaseWidget):
         Number of max spikes per unit to display. Use None for all spikes.
     with_channel_ids : bool, default: False
         Add channel ids text on the probe
-    unit_colors :  dict or None, default: None
-        If given, a dictionary with unit ids as keys and colors as values
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     hide_unit_selector : bool, default: False
         For sortingview backend, if True the unit selector is not displayed
     plot_all_units : bool, default: True

src/spikeinterface/widgets/spikes_on_traces.py

@@ -32,9 +32,9 @@ class SpikesOnTracesWidget(BaseWidget):
     sparsity : ChannelSparsity or None, default: None
         Optional ChannelSparsity to apply
         If SortingAnalyzer is already sparse, the argument is ignored
-    unit_colors : dict or None, default: None
-        If given, a dictionary with unit ids as keys and colors as values
-        If None, then the get_unit_colors() is internally used. (matplotlib backend)
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     mode : "line" | "map" | "auto", default: "auto"
         * "line": classical for low channel count
         * "map": for high channel count use color heat map

src/spikeinterface/widgets/template_metrics.py

@@ -18,8 +18,9 @@ class TemplateMetricsWidget(MetricsBaseWidget):
         If given list of quality metrics to include
     skip_metrics : list or None or None, default: None
         If given, a list of quality metrics to skip
-    unit_colors : dict or None, default: None
-        If given, a dictionary with unit ids as keys and colors as values
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     hide_unit_selector : bool, default: False
         For sortingview backend, if True the unit selector is not displayed
     """

src/spikeinterface/widgets/unit_depths.py

@@ -18,8 +18,9 @@ class UnitDepthsWidget(BaseWidget):
     ----------
     sorting_analyzer : SortingAnalyzer
         The SortingAnalyzer object
-    unit_colors :  dict or None, default: None
-        If given, a dictionary with unit ids as keys and colors as values
+    unit_colors : dict | None, default: None
+        Dict of colors with unit ids as keys and colors as values. Colors can be any type accepted
+        by matplotlib. If None, default colours are chosen using the `get_some_colors` function.
     depth_axis : int, default: 1
         The dimension of unit_locations that is depth
     peak_sign : "neg" | "pos" | "both", default: "neg"