DOC: patch up documentation on Axes

tacaswell · tacaswell · commit 474f1eebfdc0 · 2016-09-25T15:50:01.000-04:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -107,6 +107,8 @@ class Axes(_AxesBase):
     """
     ### Labelling, legend and texts
 
+    aname = 'Axes'
+
     def get_title(self, loc="center"):
         """Get an axes title.
 
diff --git a/lib/matplotlib/axes/_base.py b/lib/matplotlib/axes/_base.py
@@ -844,8 +844,9 @@ def get_position(self, original=False):
             return self._position.frozen()
 
     def set_position(self, pos, which='both'):
-        """
-        Set the axes position with::
+        """Set the axes position
+
+        The expected shape of ``pos`` is::
 
           pos = [left, bottom, width, height]
 
@@ -1188,13 +1189,14 @@ def ishold(self):
         return self._hold
 
     def hold(self, b=None):
-        """
+        """Set the hold state
+
         Call signature::
 
           hold(b=None)
 
-        Set the hold state.  If *hold* is *None* (default), toggle the
-        *hold* state.  Else set the *hold* state to boolean value *b*.
+        If *hold* is *None* (default), toggle the *hold* state.  Else
+        set the *hold* state to boolean value *b*.
 
         Examples::
 
@@ -2727,11 +2729,16 @@ def xaxis_inverted(self):
         return right < left
 
     def get_xbound(self):
-        """
-        Returns the x-axis numerical bounds where::
+        """Returns the x-axis numerical bounds
+
+        This always returns::
 
           lowerBound < upperBound
 
+        Returns
+        -------
+        lowerBound, upperBound : float
+
         """
         left, right = self.get_xlim()
         if left < right:
@@ -2773,7 +2780,8 @@ def get_xlim(self):
         return tuple(self.viewLim.intervalx)
 
     def set_xlim(self, left=None, right=None, emit=True, auto=False, **kw):
-        """
+        """Set the data limits for the xaxis
+
         Call signature::
 
           set_xlim(self, *args, **kwargs):
@@ -2871,7 +2879,8 @@ def get_xscale(self):
 
     @docstring.dedent_interpd
     def set_xscale(self, value, **kwargs):
-        """
+        """Set the x-axis scale
+
         Call signature::
 
           set_xscale(value)
@@ -2953,12 +2962,13 @@ def get_xticklabels(self, minor=False, which=None):
 
     @docstring.dedent_interpd
     def set_xticklabels(self, labels, fontdict=None, minor=False, **kwargs):
-        """
+        """Set the xtick labels with list of strings *labels*
+
         Call signature::
 
           set_xticklabels(labels, fontdict=None, minor=False, **kwargs)
 
-        Set the xtick labels with list of strings *labels*. Return a
+        Return a
         list of axis text instances.
 
         *kwargs* set the :class:`~matplotlib.text.Text` properties.
@@ -3031,13 +3041,12 @@ def get_ylim(self):
         return tuple(self.viewLim.intervaly)
 
     def set_ylim(self, bottom=None, top=None, emit=True, auto=False, **kw):
-        """
+        """Set the data limits for the yaxis
+
         Call signature::
 
           set_ylim(self, *args, **kwargs):
 
-        Set the data limits for the yaxis
-
         Examples::
 
           set_ylim((bottom, top))
@@ -3130,7 +3139,8 @@ def get_yscale(self):
 
     @docstring.dedent_interpd
     def set_yscale(self, value, **kwargs):
-        """
+        """Set the y-axis scale
+
         Call signature::
 
           set_yscale(value)
@@ -3215,12 +3225,13 @@ def get_yticklabels(self, minor=False, which=None):
 
     @docstring.dedent_interpd
     def set_yticklabels(self, labels, fontdict=None, minor=False, **kwargs):
-        """
+        """Set the y tick labels with list of strings *labels*
+
         Call signature::
 
           set_yticklabels(labels, fontdict=None, minor=False, **kwargs)
 
-        Set the y tick labels with list of strings *labels*.  Return a list of
+        Return a list of
         :class:`~matplotlib.text.Text` instances.
 
         *kwargs* set :class:`~matplotlib.text.Text` properties for the labels.
@@ -3626,8 +3637,9 @@ def get_cursor_props(self):
         return self._cursorProps
 
     def set_cursor_props(self, *args):
-        """
-        Set the cursor property as::
+        """Set the cursor property as
+
+        Call signature ::
 
           ax.set_cursor_props(linewidth, color)
 
@@ -3688,7 +3700,8 @@ def contains_point(self, point):
         return self.patch.contains_point(point, radius=1.0)
 
     def pick(self, *args):
-        """
+        """Trigger pick event
+
         Call signature::
 
             pick(mouseevent)
@@ -3760,7 +3773,8 @@ def _make_twin_axes(self, *kl, **kwargs):
         return ax2
 
     def twinx(self):
-        """
+        """Create a twin Axes sharing the xaxis
+
         Call signature::
 
           ax = twinx()
@@ -3785,7 +3799,8 @@ def twinx(self):
         return ax2
 
     def twiny(self):
-        """
+        """Create a twin Axes sharing the yaxis
+
         Call signature::
 
           ax = twiny()
