DOC: Fix overly long header underlining.

matplotlib · Kojoley · Oct 27, 2016 · Dec 24, 2015 · Dec 24, 2015 · Jan 4, 2016
commit bb78abb7612ed524e1cdcaaed129e7d8a1cb52ea
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -751,7 +751,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
 
 
         Examples
-        ---------
+        --------
         * draw a thick red vline at *x* = 0 that spans the yrange::
 
             >>> axvline(linewidth=4, color='r')
@@ -1034,7 +1034,7 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
         hlines : horizontal lines
 
         Examples
-        ---------
+        --------
         .. plot:: mpl_examples/pylab_examples/vline_hline_demo.py
 
         """
@@ -1702,7 +1702,7 @@ def acorr(self, x, **kwargs):
           - `b` is the x-axis.
 
         Other parameters
-        -----------------
+        ----------------
         linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None
             Only used if usevlines is False.
 
@@ -1766,7 +1766,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
           - `b` is the x-axis (none, if plot is used).
 
         Other parameters
-        -----------------
+        ----------------
         linestyle : `~matplotlib.lines.Line2D` prop, optional, default: None
             Only used if usevlines is False.
 
@@ -2231,7 +2231,7 @@ def barh(self, bottom, width, height=0.8, left=None, **kwargs):
             the x coordinates of the left sides of the bars
 
         Returns
-        --------
+        -------
         `matplotlib.patches.Rectangle` instances.
 
         Other parameters
@@ -5034,7 +5034,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
         Display an image on the axes.
 
         Parameters
-        -----------
+        ----------
         X : array_like, shape (n, m) or (n, m, 3) or (n, m, 4)
             Display the image in `X` to current axes.  `X` may be an
             array or a PIL image. If `X` is an array, it
@@ -5117,7 +5117,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
             when interpolation is one of: 'sinc', 'lanczos' or 'blackman'
 
         Returns
-        --------
+        -------
         image : `~matplotlib.image.AxesImage`
 
         Other parameters
@@ -6528,7 +6528,7 @@ def hist2d(self, x, y, bins=10, range=None, normed=False, weights=None,
         The return value is ``(counts, xedges, yedges, Image)``.
 
         Other parameters
-        -----------------
+        ----------------
         kwargs : :meth:`pcolorfast` properties.
 
         See also

diff --git a/lib/matplotlib/backend_managers.py b/lib/matplotlib/backend_managers.py
@@ -79,7 +79,7 @@ def toolmanager_connect(self, s, func):
         Connect event with string *s* to *func*.
 
         Parameters
-        -----------
+        ----------
         s : String
             Name of the event
 
@@ -138,7 +138,7 @@ def get_tool_keymap(self, name):
             Name of the Tool
 
         Returns
-        ----------
+        -------
         list : list of keys associated with the Tool
         """
 
@@ -379,7 +379,7 @@ def get_tool(self, name, warn=True):
         Return the tool object, also accepts the actual tool for convenience
 
         Parameters
-        -----------
+        ----------
         name : str, ToolBase
             Name of the tool, or the tool itself
         warn : bool, optional

diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
@@ -86,7 +86,7 @@ def warn_deprecated(
     Used to display deprecation warning in a standard way.
 
     Parameters
-    ------------
+    ----------
     since : str
         The release at which this API became deprecated.
 
@@ -143,7 +143,7 @@ def deprecated(since, message='', name='', alternative='', pending=False,
     Decorator to mark a function as deprecated.
 
     Parameters
-    ------------
+    ----------
     since : str
         The release at which this API became deprecated.  This is
         required.
@@ -599,7 +599,7 @@ def local_over_kwdict(local_var, kwargs, *keys):
     kwargs dict in place.
 
     Parameters
-    ------------
+    ----------
         local_var: any object
             The local variable (highest priority)
 
@@ -611,12 +611,12 @@ def local_over_kwdict(local_var, kwargs, *keys):
             priority
 
     Returns
-    ---------
+    -------
         out: any object
             Either local_var or one of kwargs[key] for key in keys
 
     Raises
-    --------
+    ------
         IgnoredKeywordWarning
             For each key in keys that is removed from kwargs but not used as
             the output value

diff --git a/lib/matplotlib/lines.py b/lib/matplotlib/lines.py
@@ -1161,7 +1161,7 @@ def set_marker(self, marker):
         ACCEPTS: :mod:`A valid marker style <matplotlib.markers>`
 
         Parameters
-        -----------
+        ----------
 
         marker: marker style
             See `~matplotlib.markers` for full description of possible

diff --git a/lib/matplotlib/mlab.py b/lib/matplotlib/mlab.py
@@ -4,7 +4,7 @@
 commands with the same names.
 
 MATLAB compatible functions
--------------------------------
+---------------------------
 
 :func:`cohere`
     Coherence (normalized cross spectral density)
@@ -39,7 +39,7 @@
     Spectrogram (spectrum over segments of time)
 
 Miscellaneous functions
--------------------------
+-----------------------
 
 Functions that don't exist in MATLAB, but are useful anyway:
 
@@ -99,7 +99,7 @@
 
 
 record array helper functions
--------------------------------
+-----------------------------
 
 A collection of helper methods for numpyrecord arrays
 

diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -920,7 +920,7 @@ def gca(**kwargs):
     current figure matching the given keyword args, or create one.
 
     Examples
-    ---------
+    --------
     To get the current polar axes on the current figure::
 
         plt.gca(projection='polar')

diff --git a/lib/matplotlib/tri/triinterpolate.py b/lib/matplotlib/tri/triinterpolate.py
@@ -1334,14 +1334,14 @@ def _cg(A, b, x0=None, tol=1.e-10, maxiter=1000):
         Right hand side of the linear system.
 
     Returns
-    ----------
+    -------
     x: array.
         The converged solution.
     err: float
         The absolute error np.linalg.norm(A.dot(x) - b)
 
     Other parameters
-    ----------
+    ----------------
     x0: array.
         Starting guess for the solution.
     tol: float.