From 5df465049887d67ef2cfee3c80d63cb0f3363263 Mon Sep 17 00:00:00 2001 From: Jody Klymak Date: Wed, 2 May 2018 15:48:16 -0700 Subject: [PATCH] Backport PR #11161: DOC: small-doc-improvements1 --- doc/_static/mpl.css | 3 +++ lib/matplotlib/axes/_axes.py | 44 ++++++++++++++++++++++++------------ lib/matplotlib/stackplot.py | 2 +- 3 files changed, 33 insertions(+), 16 deletions(-) diff --git a/doc/_static/mpl.css b/doc/_static/mpl.css index 5ecf1d909edb..01bf76864fac 100644 --- 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 index 19dddf3f6fff..a9a81742908f 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -673,7 +673,7 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs): Returns ------- - :class:`~matplotlib.lines.Line2D` + line : :class:`~matplotlib.lines.Line2D` Other Parameters ---------------- @@ -743,7 +743,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs): Returns ------- - :class:`~matplotlib.lines.Line2D` + line : :class:`~matplotlib.lines.Line2D` Other Parameters ---------------- @@ -1138,8 +1138,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 ----- @@ -2064,7 +2065,7 @@ def bar(self, *args, **kwargs): Returns ------- - `.BarContainer` + container : `.BarContainer` Container with all the bars and optionally errorbars. Other Parameters @@ -2088,9 +2089,13 @@ def bar(self, *args, **kwargs): - 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. @@ -2384,7 +2389,7 @@ def barh(self, *args, **kwargs): Returns ------- - `.BarContainer` + container : `.BarContainer` Container with all the bars and optionally errorbars. Other Parameters @@ -2408,9 +2413,13 @@ def barh(self, *args, **kwargs): - 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. @@ -2521,7 +2530,7 @@ def broken_barh(self, xranges, yrange, **kwargs): Returns ------- - :class:`matplotlib.collections.BrokenBarHCollection` + collection : A :class:`~.collections.BrokenBarHCollection` Notes ----- @@ -2621,8 +2630,8 @@ def stem(self, *args, **kwargs): 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*) @@ -2992,9 +3001,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. @@ -3040,7 +3054,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 index c16ef36eea0d..2b57aeb2b965 100644 --- a/lib/matplotlib/stackplot.py +++ b/lib/matplotlib/stackplot.py @@ -56,7 +56,7 @@ def stackplot(axes, x, *args, **kwargs): Returns ------- - list of `.PolyCollection` + list : list of `.PolyCollection` A list of `.PolyCollection` instances, one for each element in the stacked area plot. """