Merge pull request #21385 from dstansby/gridspec-doc

QuLogic · web-flow · commit fb389ab1ab73 · 2021-10-19T15:21:45.000-04:00
Document what indexing a GridSpec returns
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -330,6 +330,8 @@ class GridSpec(GridSpecBase):
     The location of the grid cells is determined in a similar way to
     `~.figure.SubplotParams` using *left*, *right*, *top*, *bottom*, *wspace*
     and *hspace*.
+
+    Indexing a GridSpec instance returns a `.SubplotSpec`.
     """
     def __init__(self, nrows, ncols, figure=None,
                  left=None, bottom=None, right=None, top=None,
