Commit3e9bdbe

committed

TYP: Accept tuples in Legend handles list

1 parent6c7637a commit3e9bdbeCopy full SHA for 3e9bdbe

File tree

-6

lines changed

-6

lines changed

Lines changed: 4 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -280,7 +280,7 @@ def legend(self, args, *kwargs):`
`280`	`280`
`281`	`281`	`Parameters`
`282`	`282`	`----------`
`283`		- handles : sequence of `.Artist`, optional
	`283`	+ handles : sequence of(`.Artist` or tuple of `.Artist`), optional
`284`	`284`	`A list of Artists (lines, patches) to be added to the legend.`
`285`	`285`	`Use this together with labels, if you need full control on what`
`286`	`286`	`is shown in the legend and the automatic mechanism described above`
`@@ -289,6 +289,9 @@ def legend(self, args, *kwargs):`
`289`	`289`	`The length of handles and labels should be the same in this`
`290`	`290`	`case. If they are not, they are truncated to the smaller length.`
`291`	`291`
	`292`	`+ If an entry contains a tuple, then the legend handler for all Artists in the`
	`293`	`+ tuple will be placed alongside a single label.`
	`294`	`+`
`292`	`295`	`labels : list of str, optional`
`293`	`296`	`A list of labels to show next to the artists.`
`294`	`297`	`Use this together with handles, if you need full control on what`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -57,9 +57,9 @@ class Axes(_AxesBase):`
`57`	`57`	`@overload`
`58`	`58`	`deflegend(self)->Legend: ...`
`59`	`59`	`@overload`
`60`		`-deflegend(self,handles:Sequence[Artist],labels:Sequence[str],**kwargs)->Legend: ...`
	`60`	`+deflegend(self,handles:Sequence[Artist\|tuple[Artist, ...]],labels:Sequence[str],**kwargs)->Legend: ...`
`61`	`61`	`@overload`
`62`		`-deflegend(self,,handles:Sequence[Artist],*kwargs)->Legend: ...`
	`62`	`+deflegend(self,,handles:Sequence[Artist\|tuple[Artist, ...]],*kwargs)->Legend: ...`
`63`	`63`	`@overload`
`64`	`64`	`deflegend(self,labels:Sequence[str],**kwargs)->Legend: ...`
`65`	`65`	`@overload`

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -401,7 +401,7 @@ def __init__(`
`401`	`401`	parent : `~matplotlib.axes.Axes` or `.Figure`
`402`	`402`	`The artist that contains the legend.`
`403`	`403`
`404`		- handles : list of `.Artist`
	`404`	+ handles : list of(`.Artist` or tuple of `.Artist`)
`405`	`405`	`A list of Artists (lines, patches) to be added to the legend.`
`406`	`406`
`407`	`407`	`labels : list of str`
`@@ -1322,7 +1322,7 @@ def _parse_legend_args(axs, args, handles=None, labels=None, *kwargs):`
`1322`	`1322`
`1323`	`1323`	`Returns`
`1324`	`1324`	`-------`
`1325`		- handles : list of `.Artist`
	`1325`	+ handles : list of(`.Artist` or tuple of `.Artist`)
`1326`	`1326`	`The legend handles.`
`1327`	`1327`	`labels : list of str`
`1328`	`1328`	`The legend labels.`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ class Legend(Artist):`
`52`	`52`	`def__init__(`
`53`	`53`	`self,`
`54`	`54`	`parent:Axes\|Figure,`
`55`		`-handles:Iterable[Artist],`
	`55`	`+handles:Iterable[Artist\|tuple[Artist, ...]],`
`56`	`56`	`labels:Iterable[str],`
`57`	`57`	`*,`
`58`	`58`	`loc:str\|tuple[float,float]\|int\|None= ...,`

Comments

(0)