Skip to content

Commit c28a063

Browse files
ImportanceOfBeingErnestImportanceOfBeingErnest
committed
small-doc-improvements1
1 parent bdaafd9 commit c28a063

File tree

3 files changed

+33
-16
lines changed

3 files changed

+33
-16
lines changed

‎doc/_static/mpl.css

+3
Original file line numberDiff line numberDiff line change
@@ -713,6 +713,9 @@ table.docutils.field-list {
713713
font-size: 13px;
714714
line-height: 18px;
715715
}
716+
.docutils.field-list td blockquote p ul li{
717+
font-size: 13px;
718+
}
716719
p.rubric {
717720
font-weight: bold;
718721
font-size: 19px;

‎lib/matplotlib/axes/_axes.py

+29-15
Original file line numberDiff line numberDiff line change
@@ -499,7 +499,7 @@ def axhline(self, y=0, xmin=0, xmax=1, **kwargs):
499499
500500
Returns
501501
-------
502-
:class:`~matplotlib.lines.Line2D`
502+
line : :class:`~matplotlib.lines.Line2D`
503503
504504
Other Parameters
505505
----------------
@@ -569,7 +569,7 @@ def axvline(self, x=0, ymin=0, ymax=1, **kwargs):
569569
570570
Returns
571571
-------
572-
:class:`~matplotlib.lines.Line2D`
572+
line : :class:`~matplotlib.lines.Line2D`
573573
574574
Other Parameters
575575
----------------
@@ -964,8 +964,9 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
964964
Returns
965965
-------
966966
967-
A list of :class:`matplotlib.collections.EventCollection` objects that
968-
were added.
967+
list : A list of :class:`~.collections.EventCollection` objects.
968+
Contains the :class:`~.collections.EventCollection` that
969+
were added.
969970
970971
Notes
971972
-----
@@ -1849,7 +1850,7 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
18491850
18501851
Returns
18511852
-------
1852-
`.BarContainer`
1853+
container : `.BarContainer`
18531854
Container with all the bars and optionally errorbars.
18541855
18551856
Other Parameters
@@ -1873,9 +1874,13 @@ def bar(self, x, height, width=0.8, bottom=None, *, align="center",
18731874
18741875
- scalar: symmetric +/- values for all bars
18751876
- shape(N,): symmetric +/- values for each bar
1876-
- shape(2,N): separate + and - values for each bar
1877+
- shape(2,N): Separate - and + values for each bar. First row
1878+
contains the lower errors, the second row contains the
1879+
upper errors.
1880+
- *None*: No errorbar. (Default)
18771881
1878-
Default: None
1882+
See :ref:`sphx_glr_gallery_statistics_errorbar_features.py`
1883+
for an example on the usage of ``xerr`` and ``yerr``.
18791884
18801885
ecolor : scalar or array-like, optional, default: 'black'
18811886
The line color of the errorbars.
@@ -2124,7 +2129,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
21242129
21252130
Returns
21262131
-------
2127-
`.BarContainer`
2132+
container : `.BarContainer`
21282133
Container with all the bars and optionally errorbars.
21292134
21302135
Other Parameters
@@ -2148,9 +2153,13 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
21482153
21492154
- scalar: symmetric +/- values for all bars
21502155
- shape(N,): symmetric +/- values for each bar
2151-
- shape(2,N): separate + and - values for each bar
2156+
- shape(2,N): Separate - and + values for each bar. First row
2157+
contains the lower errors, the second row contains the
2158+
upper errors.
2159+
- *None*: No errorbar. (default)
21522160
2153-
Default: None
2161+
See :ref:`sphx_glr_gallery_statistics_errorbar_features.py`
2162+
for an example on the usage of ``xerr`` and ``yerr``.
21542163
21552164
ecolor : scalar or array-like, optional, default: 'black'
21562165
The line color of the errorbars.
@@ -2235,7 +2244,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
22352244
22362245
Returns
22372246
-------
2238-
:class:`matplotlib.collections.BrokenBarHCollection`
2247+
collection : A :class:`~.collections.BrokenBarHCollection`
22392248
22402249
Notes
22412250
-----
@@ -2327,8 +2336,8 @@ def stem(self, *args, linefmt=None, markerfmt=None, basefmt=None,
23272336
23282337
Returns
23292338
-------
2330-
:class:`~matplotlib.container.StemContainer`
2331-
The stemcontainer may be treated like a tuple
2339+
container : :class:`~matplotlib.container.StemContainer`
2340+
The container may be treated like a tuple
23322341
(*markerline*, *stemlines*, *baseline*)
23332342
23342343
@@ -2671,9 +2680,14 @@ def errorbar(self, x, y, yerr=None, xerr=None,
26712680
26722681
- scalar: Symmetric +/- values for all data points.
26732682
- shape(N,): Symmetric +/-values for each data point.
2674-
- shape(2,N): Separate + and - values for each data point.
2683+
- shape(2,N): Separate - and + values for each bar. First row
2684+
contains the lower errors, the second row contains the
2685+
upper errors.
26752686
- *None*: No errorbar.
26762687
2688+
See :ref:`sphx_glr_gallery_statistics_errorbar_features.py`
2689+
for an example on the usage of ``xerr`` and ``yerr``.
2690+
26772691
fmt : plot format string, optional, default: ''
26782692
The format for the data points / data lines. See `.plot` for
26792693
details.
@@ -2719,7 +2733,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
27192733
27202734
Returns
27212735
-------
2722-
:class:`~.container.ErrorbarContainer`
2736+
container : :class:`~.container.ErrorbarContainer`
27232737
The container contains:
27242738
27252739
- plotline: :class:`~matplotlib.lines.Line2D` instance of

‎lib/matplotlib/stackplot.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def stackplot(axes, x, *args,
5353
5454
Returns
5555
-------
56-
list of `.PolyCollection`
56+
list : list of `.PolyCollection`
5757
A list of `.PolyCollection` instances, one for each element in the
5858
stacked area plot.
5959
"""

0 commit comments

Comments
 (0)