Merge pull request #10027 from dstansby/errbarcont-doc

jklymak · web-flow · commit f25e02eeff69 · 2017-12-18T13:45:14.000-08:00
Improve errorbar returns doc
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -2793,7 +2793,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
             releases.
 
         barsabove : bool, optional, default: False
-            if True , will plot the errorbars above the plot
+            If True , will plot the errorbars above the plot
             symbols. Default is below.
 
         lolims / uplims / xlolims / xuplims : bool, optional, default:None
@@ -2805,18 +2805,22 @@ def errorbar(self, x, y, yerr=None, xerr=None,
             before :meth:`errorbar`.
 
         errorevery : positive integer, optional, default:1
-            subsamples the errorbars. e.g., if errorevery=5, errorbars for
+            Subsamples the errorbars. e.g., if errorevery=5, errorbars for
             every 5-th datapoint will be plotted. The data plot itself still
             shows all data points.
 
         Returns
         -------
-        plotline : :class:`~matplotlib.lines.Line2D` instance
-            x, y plot markers and/or line
-        caplines : list of :class:`~matplotlib.lines.Line2D` instances
-            error bar cap
-        barlinecols : list of :class:`~matplotlib.collections.LineCollection`
-            horizontal and vertical error ranges.
+        :class:`~.container.ErrorbarContainer`
+            The container contains:
+
+            - plotline: :class:`~matplotlib.lines.Line2D` instance of
+              x, y plot markers and/or line.
+            - caplines: A tuple of :class:`~matplotlib.lines.Line2D` instances
+              of the error bar caps.
+            - barlinecols: A tuple of
+              :class:`~matplotlib.collections.LineCollection` with the
+              horizontal and vertical error ranges.
 
         Other Parameters
         ----------------
diff --git a/lib/matplotlib/container.py b/lib/matplotlib/container.py
@@ -114,6 +114,24 @@ def __init__(self, patches, errorbar=None, **kwargs):
 
 
 class ErrorbarContainer(Container):
+    '''
+    Container for errobars.
+
+    Attributes
+    ----------
+    lines : tuple
+        Tuple of ``(data_line, caplines, barlinecols)``.
+
+        - data_line : :class:`~matplotlib.lines.Line2D` instance of
+          x, y plot markers and/or line.
+        - caplines : tuple of :class:`~matplotlib.lines.Line2D` instances of
+          the error bar caps.
+        - barlinecols : list of :class:`~matplotlib.collections.LineCollection`
+          with the horizontal and vertical error ranges.
+
+    has_xerr, has_yerr : bool
+        ``True`` if the errorbar has x/y errors.
+    '''
 
     def __init__(self, lines, has_xerr=False, has_yerr=False, **kwargs):
         self.lines = lines
