Document that GridSpec.get_subplot_params ignores gridspec.figure.

anntzer · anntzer · commit 326ee421dee7 · 2023-05-28T12:01:17.000+02:00
It may not be the nicest API, but let's at least document it.
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -418,6 +418,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]
