Merge pull request #9790 from dstansby/gridspec-link

jklymak · web-flow · commit daf9e7109653 · 2017-11-16T17:58:11.000-08:00
Link GridSpec docs to SubplotParams paramter descriptions
diff --git a/lib/matplotlib/gridspec.py b/lib/matplotlib/gridspec.py
@@ -29,6 +29,7 @@
 
 import numpy as np
 
+
 class GridSpecBase(object):
     """
     A base class of GridSpec that specifies the geometry of the grid
@@ -187,9 +188,21 @@ def __init__(self, nrows, ncols,
                  wspace=None, hspace=None,
                  width_ratios=None, height_ratios=None):
         """
-        The number of rows and number of columns of the
-        grid need to be set. Optionally, the subplot layout parameters
-        (e.g., left, right, etc.) can be tuned.
+        The number of rows and number of columns of the grid need to be set.
+        Optionally, the subplot layout parameters (e.g., left, right, etc.)
+        can be tuned.
+
+        Parameters
+        ----------
+        nrows : int
+            Number of rows in grid.
+
+        ncols : int
+            Number or columns in grid.
+
+        Notes
+        -----
+        See `~.figure.SubplotParams` for descriptions of the layout parameters.
         """
         self.left = left
         self.bottom = bottom
@@ -239,7 +252,7 @@ def update(self, **kwargs):
 
     def get_subplot_params(self, fig=None):
         """
-        return a dictionary of subplot layout parameters. The default
+        Return a dictionary of subplot layout parameters. The default
         parameters are from rcParams unless a figure attribute is set.
         """
         from matplotlib.figure import SubplotParams
