Merge pull request #13334 from anntzer/docstringinheritance

tacaswell · web-flow · commit e7c736f82f21 · 2019-01-31T23:23:13.000-05:00
DOC: Inherit some docstrings.
diff --git a/lib/matplotlib/axis.py b/lib/matplotlib/axis.py
@@ -511,7 +511,7 @@ def update_position(self, loc):
         self.stale = True
 
     def get_view_interval(self):
-        """Return the Interval instance for this axis view limits."""
+        # docstring inherited
         return self.axes.viewLim.intervalx
 
 
@@ -895,24 +895,47 @@ def set_clip_path(self, clippath, transform=None):
         self.stale = True
 
     def get_view_interval(self):
-        'return the Interval instance for this axis view limits'
+        """Return the Interval instance for this axis view limits."""
         raise NotImplementedError('Derived must override')
 
     def set_view_interval(self, vmin, vmax, ignore=False):
+        """
+        Set the axis view limits.  This method is for internal use; Matplotlib
+        users should typically use e.g. `~Axes.set_xlim` and `~Axes.set_ylim`.
+
+        If *ignore* is False (the default), this method will never reduce the
+        preexisting view limits, only expand them if *vmin* or *vmax* are not
+        within them.  Moreover, the order of *vmin* and *vmax* does not matter;
+        the orientation of the axis will not change.
+
+        If *ignore* is True, the view limits will be set exactly to ``(vmin,
+        vmax)`` in that order.
+        """
         raise NotImplementedError('Derived must override')
 
     def get_data_interval(self):
-        'return the Interval instance for this axis data limits'
+        """Return the Interval instance for this axis data limits."""
         raise NotImplementedError('Derived must override')
 
-    def set_data_interval(self):
-        '''set the axis data limits'''
+    def set_data_interval(self, vmin, vmax, ignore=False):
+        """
+        Set the axis data limits.  This method is for internal use.
+
+        If *ignore* is False (the default), this method will never reduce the
+        preexisting data limits, only expand them if *vmin* or *vmax* are not
+        within them.  Moreover, the order of *vmin* and *vmax* does not matter;
+        the orientation of the axis will not change.
+
+        If *ignore* is True, the data limits will be set exactly to ``(vmin,
+        vmax)`` in that order.
+        """
         raise NotImplementedError('Derived must override')
 
     def set_default_intervals(self):
-        '''set the default limits for the axis data and view interval if they
-        are not mutated'''
-
+        """
+        Set the default limits for the axis data and view interval if they
+        have not been not mutated yet.
+        """
         # this is mainly in support of custom object plotting.  For
         # example, if someone passes in a datetime object, we do not
         # know automagically how to set the default min/max of the
@@ -921,7 +944,6 @@ def set_default_intervals(self):
         # default limits through the AxisInfo.default_limits
         # attribute, and the derived code below will check for that
         # and use it if is available (else just use 0..1)
-        pass
 
     def _set_artist_props(self, a):
         if a is None:
@@ -2028,19 +2050,11 @@ def get_ticks_position(self):
             return "unknown"
 
     def get_view_interval(self):
-        'return the Interval instance for this axis view limits'
+        # docstring inherited
         return self.axes.viewLim.intervalx
 
     def set_view_interval(self, vmin, vmax, ignore=False):
-        """
-        If *ignore* is *False*, the order of vmin, vmax
-        does not matter; the original axis orientation will
-        be preserved. In addition, the view limits can be
-        expanded, but will not be reduced.  This method is
-        for mpl internal use; for normal use, see
-        :meth:`~matplotlib.axes.Axes.set_xlim`.
-
-        """
+        # docstring inherited
         if ignore:
             self.axes.viewLim.intervalx = vmin, vmax
         else:
@@ -2056,11 +2070,11 @@ def get_minpos(self):
         return self.axes.dataLim.minposx
 
     def get_data_interval(self):
-        'return the Interval instance for this axis data limits'
+        # docstring inherited
         return self.axes.dataLim.intervalx
 
     def set_data_interval(self, vmin, vmax, ignore=False):
-        'set the axis data limits'
+        # docstring inherited
         if ignore:
             self.axes.dataLim.intervalx = vmin, vmax
         else:
@@ -2069,7 +2083,7 @@ def set_data_interval(self, vmin, vmax, ignore=False):
         self.stale = True
 
     def set_default_intervals(self):
-        'set the default limits for the axis interval if they are not mutated'
+        # docstring inherited
         xmin, xmax = 0., 1.
         dataMutated = self.axes.dataLim.mutatedx()
         viewMutated = self.axes.viewLim.mutatedx()
@@ -2412,19 +2426,11 @@ def get_ticks_position(self):
         return 'unknown'
 
     def get_view_interval(self):
-        'return the Interval instance for this axis view limits'
+        # docstring inherited
         return self.axes.viewLim.intervaly
 
     def set_view_interval(self, vmin, vmax, ignore=False):
-        """
-        If *ignore* is *False*, the order of vmin, vmax
-        does not matter; the original axis orientation will
-        be preserved. In addition, the view limits can be
-        expanded, but will not be reduced.  This method is
-        for mpl internal use; for normal use, see
-        :meth:`~matplotlib.axes.Axes.set_ylim`.
-
-        """
+        # docstring inherited
         if ignore:
             self.axes.viewLim.intervaly = vmin, vmax
         else:
@@ -2441,11 +2447,11 @@ def get_minpos(self):
         return self.axes.dataLim.minposy
 
     def get_data_interval(self):
-        'return the Interval instance for this axis data limits'
+        # docstring inherited
         return self.axes.dataLim.intervaly
 
     def set_data_interval(self, vmin, vmax, ignore=False):
-        'set the axis data limits'
+        # docstring inherited
         if ignore:
             self.axes.dataLim.intervaly = vmin, vmax
         else:
@@ -2454,7 +2460,7 @@ def set_data_interval(self, vmin, vmax, ignore=False):
         self.stale = True
 
     def set_default_intervals(self):
-        'set the default limits for the axis interval if they are not mutated'
+        # docstring inherited
         ymin, ymax = 0., 1.
         dataMutated = self.axes.dataLim.mutatedy()
         viewMutated = self.axes.viewLim.mutatedy()
diff --git a/lib/mpl_toolkits/mplot3d/axis3d.py b/lib/mpl_toolkits/mplot3d/axis3d.py
@@ -445,10 +445,11 @@ def draw(self, renderer):
         self.stale = False
 
     def get_view_interval(self):
-        """return the Interval instance for this 3d axis view limits"""
+        # docstring inherited
         return self.v_interval
 
     def set_view_interval(self, vmin, vmax, ignore=False):
+        # docstring inherited
         if ignore:
             self.v_interval = vmin, vmax
         else:
@@ -468,17 +469,17 @@ def get_tightbbox(self, renderer):
 
 class XAxis(Axis):
     def get_data_interval(self):
-        'return the Interval instance for this axis data limits'
+        # docstring inherited
         return self.axes.xy_dataLim.intervalx
 
 
 class YAxis(Axis):
     def get_data_interval(self):
-        'return the Interval instance for this axis data limits'
+        # docstring inherited
         return self.axes.xy_dataLim.intervaly
 
 
 class ZAxis(Axis):
     def get_data_interval(self):
-        'return the Interval instance for this axis data limits'
+        # docstring inherited
         return self.axes.zz_dataLim.intervalx
