From 326ee421dee76ff8082386887af77031ea32f5cd Mon Sep 17 00:00:00 2001
From: Antony Lee <anntzer.lee@gmail.com>
Date: Sun, 28 May 2023 12:01:17 +0200
Subject: [PATCH] Document that GridSpec.get_subplot_params ignores
 gridspec.figure.

It may not be the nicest API, but let's at least document it.
---
 lib/matplotlib/gridspec.py | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
index c9d5fbd1c7ed..c86a527ef54a 100644
--- 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]