Merge pull request matplotlib#29545 from DerWeh/doc-figaspect

DOC: correctly specify return type of `figaspect`

Author: QuLogic

lib/matplotlib/figure.py

@@ -3654,8 +3654,8 @@ def figaspect(arg):
 
     Returns
     -------
-    width, height : float
-        The figure size in inches.
+    size : (2,) array
+        The width and height of the figure in inches.
 
     Notes
     -----

lib/matplotlib/figure.pyi

@@ -418,4 +418,6 @@ class Figure(FigureBase):
         rect: tuple[float, float, float, float] | None = ...
     ) -> None: ...
 
-def figaspect(arg: float | ArrayLike) -> tuple[float, float]: ...
+def figaspect(
+    arg: float | ArrayLike,
+) -> np.ndarray[tuple[Literal[2]], np.dtype[np.float64]]: ...

lib/matplotlib/pyplot.py

@@ -875,7 +875,7 @@ def figure(
     # autoincrement if None, else integer from 1-N
     num: int | str | Figure | SubFigure | None = None,
     # defaults to rc figure.figsize
-    figsize: tuple[float, float] | None = None,
+    figsize: ArrayLike | None = None,
     # defaults to rc figure.dpi
     dpi: float | None = None,
     *,