Merge pull request #30314 from MarcoGorelli/fix-overloads

QuLogic · web-flow · commit bff64cc32e32 · 2025-07-24T02:20:42.000-04:00
[MNT] Typing: correct typing overloads for ``Figure.subfigures``
diff --git a/lib/matplotlib/figure.pyi b/lib/matplotlib/figure.pyi
@@ -191,11 +191,24 @@ class FigureBase(Artist):
     def align_labels(self, axs: Iterable[Axes] | None = ...) -> None: ...
     def add_gridspec(self, nrows: int = ..., ncols: int = ..., **kwargs) -> GridSpec: ...
     @overload
+    def subfigures(
+        self,
+        nrows: int,
+        ncols: int,
+        squeeze: Literal[False],
+        wspace: float | None = ...,
+        hspace: float | None = ...,
+        width_ratios: ArrayLike | None = ...,
+        height_ratios: ArrayLike | None = ...,
+        **kwargs
+    ) -> np.ndarray: ...
+    @overload
     def subfigures(
         self,
         nrows: int = ...,
         ncols: int = ...,
-        squeeze: Literal[False] = ...,
+        *,
+        squeeze: Literal[False],
         wspace: float | None = ...,
         hspace: float | None = ...,
         width_ratios: ArrayLike | None = ...,
