Commit 71de0a9

dstansbymeeseeksmachine

authored and

committed

Backport PR matplotlib#30412: {Check,Radio}Buttons: Improve docs of label_props

1 parent 10fb34c commit 71de0a9Copy full SHA for 71de0a9

File tree

2 files changed

+18

-10

lines changed

lib/matplotlib
- widgets.pyi
- widgets.py

2 files changed

+18

-10

lines changed

`‎lib/matplotlib/widgets.py‎`

Lines changed: 14 additions & 6 deletions

Original file line number	Diff line number	Diff line change
`@@ -1010,8 +1010,11 @@ def __init__(self, ax, labels, actives=None, *, useblit=True,`
`1010`	`1010`
`1011`	`1011`	`.. versionadded:: 3.7`
`1012`	`1012`
`1013`		`- label_props : dict, optional`
`1014`		- Dictionary of `.Text` properties to be used for the labels.
	`1013`	`+ label_props : dict of lists, optional`
	`1014`	+ Dictionary of `.Text` properties to be used for the labels. Each
	`1015`	`+ dictionary value should be a list of at least a single element. If`
	`1016`	`+ the list is of length M, its values are cycled such that the Nth`
	`1017`	`+ label gets the (N mod M) property.`
`1015`	`1018`
`1016`	`1019`	`.. versionadded:: 3.7`
`1017`	`1020`	`frame_props : dict, optional`
`@@ -1111,7 +1114,8 @@ def set_label_props(self, props):`
`1111`	`1114`	`Parameters`
`1112`	`1115`	`----------`
`1113`	`1116`	`props : dict`
`1114`		- Dictionary of `.Text` properties to be used for the labels.
	`1117`	+ Dictionary of `.Text` properties to be used for the labels. Same
	`1118`	+ format as label_props argument of :class:`CheckButtons`.
`1115`	`1119`	`"""`
`1116`	`1120`	`_api.check_isinstance(dict, props=props)`
`1117`	`1121`	`props = _expand_text_props(props)`
`@@ -1579,8 +1583,11 @@ def __init__(self, ax, labels, active=0, activecolor=None, *,`
`1579`	`1583`
`1580`	`1584`	`.. versionadded:: 3.7`
`1581`	`1585`
`1582`		`- label_props : dict or list of dict, optional`
`1583`		- Dictionary of `.Text` properties to be used for the labels.
	`1586`	`+ label_props : dict of lists, optional`
	`1587`	+ Dictionary of `.Text` properties to be used for the labels. Each
	`1588`	`+ dictionary value should be a list of at least a single element. If`
	`1589`	`+ the list is of length M, its values are cycled such that the Nth`
	`1590`	`+ label gets the (N mod M) property.`
`1584`	`1591`
`1585`	`1592`	`.. versionadded:: 3.7`
`1586`	`1593`	`radio_props : dict, optional`
`@@ -1689,7 +1696,8 @@ def set_label_props(self, props):`
`1689`	`1696`	`Parameters`
`1690`	`1697`	`----------`
`1691`	`1698`	`props : dict`
`1692`		- Dictionary of `.Text` properties to be used for the labels.
	`1699`	+ Dictionary of `.Text` properties to be used for the labels. Same
	`1700`	+ format as label_props argument of :class:`RadioButtons`.
`1693`	`1701`	`"""`
`1694`	`1702`	`_api.check_isinstance(dict, props=props)`
`1695`	`1703`	`props = _expand_text_props(props)`

`‎lib/matplotlib/widgets.pyi‎`

Lines changed: 4 additions & 4 deletions

Original file line number	Diff line number	Diff line change
`@@ -154,11 +154,11 @@ class CheckButtons(AxesWidget):`
`154`	`154`	`actives: Iterable[bool] \| None = ...,`
`155`	`155`	`*,`
`156`	`156`	`useblit: bool = ...,`
`157`		`- label_props: dict[str, Any] \| None = ...,`
	`157`	`+ label_props: dict[str, Sequence[Any]] \| None = ...,`
`158`	`158`	`frame_props: dict[str, Any] \| None = ...,`
`159`	`159`	`check_props: dict[str, Any] \| None = ...,`
`160`	`160`	`) -> None: ...`
`161`		`- def set_label_props(self, props: dict[str, Any]) -> None: ...`
	`161`	`+ def set_label_props(self, props: dict[str, Sequence[Any]]) -> None: ...`
`162`	`162`	`def set_frame_props(self, props: dict[str, Any]) -> None: ...`
`163`	`163`	`def set_check_props(self, props: dict[str, Any]) -> None: ...`
`164`	`164`	`def set_active(self, index: int, state: bool \| None = ...) -> None: ... # type: ignore[override]`
`@@ -208,10 +208,10 @@ class RadioButtons(AxesWidget):`
`208`	`208`	`activecolor: ColorType \| None = ...,`
`209`	`209`	`*,`
`210`	`210`	`useblit: bool = ...,`
`211`		`- label_props: dict[str, Any] \|Sequence[dict[str, Any]] \| None = ...,`
	`211`	`+ label_props: dict[str, Sequence[Any]] \| None = ...,`
`212`	`212`	`radio_props: dict[str, Any] \| None = ...,`
`213`	`213`	`) -> None: ...`
`214`		`- def set_label_props(self, props: dict[str, Any]) -> None: ...`
	`214`	`+ def set_label_props(self, props: dict[str, Sequence[Any]]) -> None: ...`
`215`	`215`	`def set_radio_props(self, props: dict[str, Any]) -> None: ...`
`216`	`216`	`def set_active(self, index: int) -> None: ...`
`217`	`217`	`def clear(self) -> None: ...`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit 71de0a9

File tree

2 files changed

2 files changed

`‎lib/matplotlib/widgets.py‎`

`‎lib/matplotlib/widgets.pyi‎`

0 commit comments