Apply most of the docstring fixes requested by anntzer

afvincent · afvincent · commit c3d7e8d94381 · 2017-03-06T19:38:31.000+01:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1091,9 +1091,10 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
                   linelengths=1, linewidths=None, colors=None,
                   linestyles='solid', **kwargs):
         """
-        Plot identical parallel lines at the given positions. positions should
-        be a 1D or 2D array-like object, with each row corresponding to a row
-        or column of lines.
+        Plot identical parallel lines at the given positions.
+
+        *positions* should be a 1D or 2D array-like object, with each row
+        corresponding to a row or column of lines.
 
         This type of plot is commonly used in neuroscience for representing
         neural events, where it is usually called a spike raster, dot raster,
@@ -1105,7 +1106,7 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
         date of hurricanes each year of the last century.
 
         Parameters
-        ==========
+        ----------
         positions : 1D or 2D array-like object.
             Each value is an event. If *positions* is a 2D array-like, each
             row corresponds to a row or a column of lines (depending on the
@@ -1138,23 +1139,24 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
             where *onoffseq* is an even length tuple of on and off ink
             in points.
 
-        For linelengths, linewidths, colors, and linestyles, if only a single
-        value is given, that value is applied to all lines.  If an array-like
-        is given, it must have the same length as positions, and each value
-        will be applied to the corresponding row or column in positions.
+        For *linelengths*, *linewidths*, *colors*, and *linestyles*, if only
+        a single value is given, that value is applied to all lines.  If an
+        array-like is given, it must have the same length as positions, and
+        each value will be applied to the corresponding row or column in
+        positions.
 
         kwargs are :class:`~matplotlib.collections.LineCollection` properties:
 
         %(LineCollection)s
 
         Returns
-        =======
+        -------
 
         A list of :class:`matplotlib.collections.EventCollection` objects that
         were added.
 
         Example
-        =======
+        -------
 
         .. plot:: mpl_examples/pylab_examples/eventplot_demo.py
         """
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -1263,7 +1263,7 @@ def __init__(self,
                  ):
         """
         Parameters
-        ==========
+        ----------
         positions : 1D array-like object or None.
             Each value is an event.
 
@@ -1304,7 +1304,7 @@ def __init__(self,
         %(LineCollection)s
 
         Example
-        =======
+        -------
 
         .. plot:: mpl_examples/pylab_examples/eventcollection_demo.py
         """
