DOC nitpicks on the acorr methods

NelleV · NelleV · commit e015a0c15e96 · 2013-07-05T12:28:02.000+02:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -129,8 +129,7 @@ def set_title(self, label, fontdict=None, loc="center", **kwargs):
         default = {
             'fontsize': rcParams['axes.titlesize'],
             'verticalalignment': 'baseline',
-            'horizontalalignment': loc.lower()
-            }
+            'horizontalalignment': loc.lower()}
         title.set_text(label)
         title.update(default)
         if fontdict is not None:
@@ -455,7 +454,7 @@ def text(self, x, y, s, fontdict=None,
         """
         Add text to the axes.
 
-        Add text in string *s* to axis at location *x*, *y*, data
+        Add text in string `s` to axis at location `x`, `y`, data
         coordinates.
 
         Parameters
@@ -496,7 +495,7 @@ def text(self, x, y, s, fontdict=None,
             ...      transform=ax.transAxes)
 
         You can put a rectangular box around the text instance (e.g., to
-        set a background color) by using the keyword *bbox*.  *bbox* is
+        set a background color) by using the keyword `bbox`.  `bbox` is
         a dictionary of `~matplotlib.patches.Rectangle`
         properties.  For example::
 
@@ -506,8 +505,7 @@ def text(self, x, y, s, fontdict=None,
             'verticalalignment': 'baseline',
             'horizontalalignment': 'left',
             'transform': self.transData,
-            'clip_on': False
-            }
+            'clip_on': False}
 
         # At some point if we feel confident that TextWithDash
         # is robust as a drop-in replacement for Text and that
@@ -803,15 +801,13 @@ def axvspan(self, xmin, xmax, ymin=0, ymax=1, **kwargs):
 
     @docstring.dedent
     def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
-                     label='', **kwargs):
+               label='', **kwargs):
         """
-        Plot horizontal lines.
-
         Plot horizontal lines at each `y` from `xmin` to `xmax`.
 
         Parameters
         ----------
-        y : scalar or 1D array_like
+        y : scalar or sequence of scalar
             y-indexes where to plot the lines.
 
         xmin, xmax : scalar or 1D array_like
@@ -1549,10 +1545,10 @@ def acorr(self, x, **kwargs):
             lag.
 
         usevlines : boolean, optional, default: True
-            if True, Axes.vlines is used to plot the vertical lines from the origin
-            to the acorr. Otherwise, Axes.plot is used.
+            if True, Axes.vlines is used to plot the vertical lines from the
+            origin to the acorr. Otherwise, Axes.plot is used.
 
-        maxlags : integer, optional, default: 10 
+        maxlags : integer, optional, default: 10
             number of lags to show. If None, will return all 2 * len(x) - 1
             lags.
 
@@ -1568,7 +1564,7 @@ def acorr(self, x, **kwargs):
 
         Other parameters
         -----------------
-        linestyle : `~matplotlib.lines.Line2D` properties, optional, default: None
+        linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None
             Only used if usevlines is False.
 
         marker : string, optional, default: 'o'
@@ -1599,7 +1595,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
         ----------
 
         x : sequence of scalars of length n
-        
+
         y : sequence of scalars of length n
 
         hold : boolean, optional, default: True
@@ -1613,10 +1609,10 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
             lag.
 
         usevlines : boolean, optional, default: True
-            if True, Axes.vlines is used to plot the vertical lines from the origin
-            to the acorr. Otherwise, Axes.plot is used.
+            if True, Axes.vlines is used to plot the vertical lines from the
+            origin to the acorr. Otherwise, Axes.plot is used.
 
-        maxlags : integer, optional, default: 10 
+        maxlags : integer, optional, default: 10
             number of lags to show. If None, will return all 2 * len(x) - 1
             lags.
 
@@ -1632,7 +1628,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
 
         Other parameters
         -----------------
-        linestyle : `~matplotlib.lines.Line2D` properties, optional, default: None
+        linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None
             Only used if usevlines is False.
 
         marker : string, optional, default: 'o'
