Rename to Figure.subplots; typo fixes.

anntzer · anntzer · commit 92a386c605e0 · 2015-10-11T21:08:18.000-07:00
diff --git a/lib/matplotlib/figure.py b/lib/matplotlib/figure.py
@@ -1002,8 +1002,8 @@ def add_subplot(self, *args, **kwargs):
         self.stale = True
         return a
 
-    def add_subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
-                     squeeze=True, subplot_kw=None, gridspec_kw=None):
+    def subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
+                 squeeze=True, subplot_kw=None, gridspec_kw=None):
         """
         Add a set of subplots to this figure.
 
@@ -1029,10 +1029,10 @@ def add_subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
         sharey : {"none", "all", "row", "col"} or bool, default: False
             If *False*, or "none", each subplot has its own Y axis.
 
-            If *True*, or "all", all subplots will share an Y axis, and the x
+            If *True*, or "all", all subplots will share an Y axis, and the y
             tick labels on all but the first column of plots will be invisible.
 
-            If "row", each subplot row will share an Y axis, and the x tick
+            If "row", each subplot row will share an Y axis, and the y tick
             labels on all but the first column of plots will be invisible.
 
             If "col", each subplot column will share an Y axis.
@@ -1049,9 +1049,8 @@ def add_subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
 
             - for NxM subplots with N>1 and M>1 are returned as a 2d array.
 
-            If *False*, no squeezing at all is done: the returned axes object
-            is always a 2-d array of Axes instances, even if it ends up being
-            1x1.
+            If *False*, no squeezing at all is done: the returned object is
+            always a 2-d array of Axes instances, even if it ends up being 1x1.
 
         subplot_kw : dict, default: {}
             Dict with keywords passed to the
@@ -1066,7 +1065,7 @@ def add_subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
         Returns
         -------
         ax : single Axes object or array of Axes objects
-            The addes axes.  The dimensions of the resulting array can be
+            The added axes.  The dimensions of the resulting array can be
             controlled with the squeeze keyword, see above.
 
         See Also
@@ -1114,30 +1113,27 @@ def add_subplots(self, nrows=1, ncols=1, sharex=False, sharey=False,
                 axarr[row, col] = self.add_subplot(gs[row, col], **subplot_kw)
 
         # turn off redundant tick labeling
-        if sharex in ["col", "all"] and nrows > 1:
+        if sharex in ["col", "all"]:
             # turn off all but the bottom row
             for ax in axarr[:-1, :].flat:
                 for label in ax.get_xticklabels():
                     label.set_visible(False)
                 ax.xaxis.offsetText.set_visible(False)
-
-        if sharey in ["row", "all"] and ncols > 1:
+        if sharey in ["row", "all"]:
             # turn off all but the first column
             for ax in axarr[:, 1:].flat:
                 for label in ax.get_yticklabels():
                     label.set_visible(False)
                 ax.yaxis.offsetText.set_visible(False)
 
         if squeeze:
-            # Reshape the array to have the final desired dimension (nrow,ncol),
-            # though discarding unneeded dimensions that equal 1.  If we only have
-            # one subplot, just return it instead of a 1-element array.
+            # Discarding unneeded dimensions that equal 1.  If we only have one
+            # subplot, just return it instead of a 1-element array.
             return axarr.item() if axarr.size == 1 else axarr.squeeze()
         else:
-            # returned axis array will be always 2-d, even if nrows=ncols=1
+            # Returned axis array will be always 2-d, even if nrows=ncols=1.
             return axarr
 
-
     def clf(self, keep_observers=False):
         """
         Clear the figure.
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -1132,9 +1132,9 @@ def subplots(nrows=1, ncols=1, sharex=False, sharey=False, squeeze=True,
         plt.subplots(2, 2, sharex=True, sharey=True)
     """
     fig = figure(**fig_kw)
-    axs = fig.add_subplots(
-        nrows=nrows, ncols=ncols, sharex=sharex, sharey=sharey, squeeze=squeeze,
-        subplot_kw=subplot_kw, gridspec_kw=gridspec_kw)
+    axs = fig.subplots(nrows=nrows, ncols=ncols, sharex=sharex, sharey=sharey,
+                       squeeze=squeeze, subplot_kw=subplot_kw,
+                       gridspec_kw=gridspec_kw)
     return fig, axs
 
 
