Merge pull request #11161 from ImportanceOfBeingErnest/small-doc-improvements1

jklymak · web-flow · commit 2f3e81b74d7f · 2018-05-02T15:48:16.000-07:00
DOC: small-doc-improvements1
diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css
@@ -713,6 +713,9 @@ table.docutils.field-list {
     font-size: 13px;
     line-height: 18px;
 }
+.docutils.field-list td blockquote p ul li{
+    font-size: 13px;
+}
 p.rubric {
     font-weight: bold;
     font-size: 19px;
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -499,7 +499,7 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
 
         Returns
         -------
-        :class:`~matplotlib.lines.Line2D`
+        line : :class:`~matplotlib.lines.Line2D`
 
         Other Parameters
         ----------------
@@ -569,7 +569,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
 
         Returns
         -------
-        :class:`~matplotlib.lines.Line2D`
+        line : :class:`~matplotlib.lines.Line2D`
 
         Other Parameters
         ----------------
@@ -964,8 +964,9 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
         Returns
         -------
 
-        A list of :class:`matplotlib.collections.EventCollection` objects that
-        were added.
+        list : A list of :class:`~.collections.EventCollection` objects.
+            Contains the :class:`~.collections.EventCollection` that
+            were added.
 
         Notes
         -----
@@ -1849,7 +1850,7 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
 
         Returns
         -------
-        `.BarContainer`
+        container : `.BarContainer`
             Container with all the bars and optionally errorbars.
 
         Other Parameters
@@ -1873,9 +1874,13 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
 
             - scalar: symmetric +/- values for all bars
             - shape(N,): symmetric +/- values for each bar
-            - shape(2,N): separate + and - values for each bar
+            - shape(2,N): Separate - and + values for each bar. First row
+                contains the lower errors, the second row contains the
+                upper errors.
+            - *None*: No errorbar. (Default)
 
-            Default: None
+            See :ref:`sphx_glr_gallery_statistics_errorbar_features.py`
+            for an example on the usage of ``xerr`` and ``yerr``.
 
         ecolor : scalar or array-like, optional, default: 'black'
             The line color of the errorbars.
@@ -2124,7 +2129,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
 
         Returns
         -------
-        `.BarContainer`
+        container : `.BarContainer`
             Container with all the bars and optionally errorbars.
 
         Other Parameters
@@ -2148,9 +2153,13 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
 
             - scalar: symmetric +/- values for all bars
             - shape(N,): symmetric +/- values for each bar
-            - shape(2,N): separate + and - values for each bar
+            - shape(2,N): Separate - and + values for each bar. First row
+                contains the lower errors, the second row contains the
+                upper errors.
+            - *None*: No errorbar. (default)
 
-            Default: None
+            See :ref:`sphx_glr_gallery_statistics_errorbar_features.py`
+            for an example on the usage of ``xerr`` and ``yerr``.
 
         ecolor : scalar or array-like, optional, default: 'black'
             The line color of the errorbars.
@@ -2235,7 +2244,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
 
         Returns
         -------
-        :class:`matplotlib.collections.BrokenBarHCollection`
+        collection : A :class:`~.collections.BrokenBarHCollection`
 
         Notes
         -----
@@ -2327,8 +2336,8 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None,
 
         Returns
         -------
-        :class:`~matplotlib.container.StemContainer`
-            The stemcontainer may be treated like a tuple
+        container : :class:`~matplotlib.container.StemContainer`
+            The container may be treated like a tuple
             (*markerline*, *stemlines*, *baseline*)
 
 
@@ -2671,9 +2680,14 @@ def errorbar(self, x, y, yerr=None, xerr=None,
 
             - scalar: Symmetric +/- values for all data points.
             - shape(N,): Symmetric +/-values for each data point.
-            - shape(2,N): Separate + and - values for each data point.
+            - shape(2,N): Separate - and + values for each bar. First row
+                contains the lower errors, the second row contains the
+                upper errors.
             - *None*: No errorbar.
 
+            See :ref:`sphx_glr_gallery_statistics_errorbar_features.py`
+            for an example on the usage of ``xerr`` and ``yerr``.
+
         fmt : plot format string, optional, default: ''
             The format for the data points / data lines. See `.plot` for
             details.
@@ -2719,7 +2733,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
 
         Returns
         -------
-        :class:`~.container.ErrorbarContainer`
+        container : :class:`~.container.ErrorbarContainer`
             The container contains:
 
             - plotline: :class:`~matplotlib.lines.Line2D` instance of
diff --git a/lib/matplotlib/stackplot.py b/lib/matplotlib/stackplot.py
@@ -53,7 +53,7 @@ def stackplot(axes, x, *args,
 
     Returns
     -------
-    list of `.PolyCollection`
+    list : list of `.PolyCollection`
         A list of `.PolyCollection` instances, one for each element in the
         stacked area plot.
     """
