Backport PR matplotlib#25992: Document that GridSpec.get_subplot_params ignores gridspec.figure.

rcomer · meeseeksmachine · commit 1d529de04fa1 · 2023-05-28T13:34:18.000Z
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -419,6 +419,8 @@ def get_subplot_params(self, figure=None):
         - non-*None* attributes of the GridSpec
         - the provided *figure*
         - :rc:`figure.subplot.*`
+
+        Note that the ``figure`` attribute of the GridSpec is always ignored.
         """
         if figure is None:
             kw = {k: mpl.rcParams["figure.subplot."+k]
