Cleanup axes_divider docstrings.

anntzer · anntzer · commit edbe2b1428bf · 2021-04-25T00:24:54.000+02:00
HBoxDivider.new_locator doesn't have ny, ny1 parameters.

The HBoxDivider.locate and VBoxDivider.locate docstrings are just
copy-pasted from the parent one.
diff --git a/lib/mpl_toolkits/axes_grid1/axes_divider.py b/lib/mpl_toolkits/axes_grid1/axes_divider.py
@@ -625,8 +625,6 @@ def new_locator(self, nx, nx1=None):
             cell. When *nx1* is None, a single *nx*-th column is
             specified. Otherwise location of columns spanning between *nx*
             to *nx1* (but excluding *nx1*-th column) is specified.
-        ny, ny1 : int
-            Same as *nx* and *nx1*, but for row positions.
         """
         return AxesLocator(self, nx, 0, nx1, None)
 
@@ -655,21 +653,7 @@ def _locate(self, x, y, w, h,
         return x0, y0, ox, hh
 
     def locate(self, nx, ny, nx1=None, ny1=None, axes=None, renderer=None):
-        """
-        Parameters
-        ----------
-        axes_divider : AxesDivider
-        nx, nx1 : int
-            Integers specifying the column-position of the
-            cell. When *nx1* is None, a single *nx*-th column is
-            specified. Otherwise location of columns spanning between *nx*
-            to *nx1* (but excluding *nx1*-th column) is specified.
-        ny, ny1 : int
-            Same as *nx* and *nx1*, but for row positions.
-        axes
-        renderer
-        """
-
+        # docstring inherited
         figW, figH = self._fig.get_size_inches()
         x, y, w, h = self.get_position_runtime(axes, renderer)
 
@@ -707,27 +691,12 @@ def new_locator(self, ny, ny1=None):
         return AxesLocator(self, 0, ny, None, ny1)
 
     def locate(self, nx, ny, nx1=None, ny1=None, axes=None, renderer=None):
-        """
-        Parameters
-        ----------
-        axes_divider : AxesDivider
-        nx, nx1 : int
-            Integers specifying the column-position of the
-            cell. When *nx1* is None, a single *nx*-th column is
-            specified. Otherwise location of columns spanning between *nx*
-            to *nx1* (but excluding *nx1*-th column) is specified.
-        ny, ny1 : int
-            Same as *nx* and *nx1*, but for row positions.
-        axes
-        renderer
-        """
-
+        # docstring inherited
         figW, figH = self._fig.get_size_inches()
         x, y, w, h = self.get_position_runtime(axes, renderer)
 
         x_equivalent_sizes = self.get_horizontal_sizes(renderer)
         y_appended_sizes = self.get_vertical_sizes(renderer)
-
         y0, x0, oy, ww = self._locate(y, x, h, w,
                                       x_equivalent_sizes, y_appended_sizes,
                                       figH, figW)
