Commitc70cd78

authored

Merge pull request#29545 from DerWeh/doc-figaspect

DOC: correctly specify return type of `figaspect`

2 parentsa364dc5 +59b6d9c commitc70cd78Copy full SHA for c70cd78

File tree

-4

lines changed

-4

lines changed

Lines changed: 2 additions & 2 deletions

Original file line number	Diff line number	Diff line change
`@@ -3654,8 +3654,8 @@ def figaspect(arg):`
`3654`	`3654`
`3655`	`3655`	`Returns`
`3656`	`3656`	`-------`
`3657`		`-width, height : float`
`3658`		`- Thefigure size in inches.`
	`3657`	`+size : (2,) array`
	`3658`	`+ Thewidth and height of the figure in inches.`
`3659`	`3659`
`3660`	`3660`	`Notes`
`3661`	`3661`	`-----`

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -418,4 +418,6 @@ class Figure(FigureBase):`
`418`	`418`	`rect:tuple[float,float,float,float]\|None= ...`
`419`	`419`	`)->None: ...`
`420`	`420`
`421`		`-deffigaspect(arg:float\|ArrayLike)->tuple[float,float]: ...`
	`421`	`+deffigaspect(`
	`422`	`+arg:float\|ArrayLike,`
	`423`	`+)->np.ndarray[tuple[Literal[2]],np.dtype[np.float64]]: ...`

Lines changed: 1 addition & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -875,7 +875,7 @@ def figure(`
`875`	`875`	`# autoincrement if None, else integer from 1-N`
`876`	`876`	`num:int\|str\|Figure\|SubFigure\|None=None,`
`877`	`877`	`# defaults to rc figure.figsize`
`878`		`-figsize:tuple[float,float]\|None=None,`
	`878`	`+figsize:ArrayLike\|None=None,`
`879`	`879`	`# defaults to rc figure.dpi`
`880`	`880`	`dpi:float\|None=None,`
`881`	`881`	`*,`

Comments

(0)