{Check,Radio}Buttons: Improve docs of label_props

doronbehar · doronbehar · commit 95c4dda1f804 · 2025-08-10T04:35:20.000+03:00
diff --git a/lib/matplotlib/widgets.py b/lib/matplotlib/widgets.py
@@ -1016,8 +1016,11 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,
 
             .. versionadded:: 3.7
 
-        label_props : dict, optional
-            Dictionary of `.Text` properties to be used for the labels.
+        label_props : dict of lists, or list of dict, optional
+            Dictionary of `.Text` properties to be used for the labels. Each
+            dictionary value should be a list of at least a single element. If
+            the list is of length M, its values are cycled such that the Nth
+            label gets the (N mod M) property.
 
             .. versionadded:: 3.7
         frame_props : dict, optional
@@ -1117,7 +1120,8 @@ def set_label_props(self, props):
         Parameters
         ----------
         props : dict
-            Dictionary of `.Text` properties to be used for the labels.
+            Dictionary of `.Text` properties to be used for the labels. Same
+            format as label_props argument of `__init__`.
         """
         _api.check_isinstance(dict, props=props)
         props = _expand_text_props(props)
@@ -1585,8 +1589,11 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,
 
             .. versionadded:: 3.7
 
-        label_props : dict or list of dict, optional
-            Dictionary of `.Text` properties to be used for the labels.
+        label_props : dict of lists, or list of dict, optional
+            Dictionary of `.Text` properties to be used for the labels. Each
+            dictionary value should be a list of at least a single element. If
+            the list is of length M, its values are cycled such that the Nth
+            label gets the (N mod M) property.
 
             .. versionadded:: 3.7
         radio_props : dict, optional
@@ -1695,7 +1702,8 @@ def set_label_props(self, props):
         Parameters
         ----------
         props : dict
-            Dictionary of `.Text` properties to be used for the labels.
+            Dictionary of `.Text` properties to be used for the labels. Same
+            format as label_props argument of `__init__`.
         """
         _api.check_isinstance(dict, props=props)
         props = _expand_text_props(props)
