Skip to content

Commit 9657378

Browse files
small-doc-improvements1
1 parent bdaafd9 commit 9657378

File tree

2 files changed

+19
-12
lines changed

2 files changed

+19
-12
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 18 additions & 11 deletions
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+
BarContainer : `.BarContainer`
18531854
Container with all the bars and optionally errorbars.
18541855
18551856
Other Parameters
@@ -1873,7 +1874,9 @@ 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.
18771880
18781881
Default: None
18791882
@@ -2124,7 +2127,7 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
21242127
21252128
Returns
21262129
-------
2127-
`.BarContainer`
2130+
BarContainer : `.BarContainer`
21282131
Container with all the bars and optionally errorbars.
21292132
21302133
Other Parameters
@@ -2148,7 +2151,9 @@ def barh(self, y, width, height=0.8, left=None, *, align="center",
21482151
21492152
- scalar: symmetric +/- values for all bars
21502153
- shape(N,): symmetric +/- values for each bar
2151-
- shape(2,N): separate + and - values for each bar
2154+
- shape(2,N): Separate - and + values for each bar. First row
2155+
contains the lower errors, the second row contains the
2156+
upper errors.
21522157
21532158
Default: None
21542159
@@ -2235,7 +2240,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
22352240
22362241
Returns
22372242
-------
2238-
:class:`matplotlib.collections.BrokenBarHCollection`
2243+
BrokenBarHCollection : A :class:`~.collections.BrokenBarHCollection`
22392244
22402245
Notes
22412246
-----
@@ -2671,7 +2676,9 @@ def errorbar(self, x, y, yerr=None, xerr=None,
26712676
26722677
- scalar: Symmetric +/- values for all data points.
26732678
- shape(N,): Symmetric +/-values for each data point.
2674-
- shape(2,N): Separate + and - values for each data point.
2679+
- shape(2,N): Separate - and + values for each bar. First row
2680+
contains the lower errors, the second row contains the
2681+
upper errors.
26752682
- *None*: No errorbar.
26762683
26772684
fmt : plot format string, optional, default: ''
@@ -2719,7 +2726,7 @@ def errorbar(self, x, y, yerr=None, xerr=None,
27192726
27202727
Returns
27212728
-------
2722-
:class:`~.container.ErrorbarContainer`
2729+
ErrorbarContainer : :class:`~.container.ErrorbarContainer`
27232730
The container contains:
27242731
27252732
- plotline: :class:`~matplotlib.lines.Line2D` instance of

lib/matplotlib/stackplot.py

Lines changed: 1 addition & 1 deletion
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)