Skip to content

DOC: small-doc-improvements1 #11161

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 2, 2018
Merged

DOC: small-doc-improvements1 #11161

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/_static/mpl.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
44 changes: 29 additions & 15 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
----------------
Expand Down Expand Up @@ -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
----------------
Expand Down Expand Up @@ -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
-----
Expand Down Expand Up @@ -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
Expand All @@ -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.
Expand Down Expand Up @@ -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
Expand All @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this sentence will be very clear to new users. Could you add an Example numpydoc section with a short example example demonstrating the clarification?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a link to this example.

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.
Expand Down Expand Up @@ -2235,7 +2244,7 @@ def broken_barh(self, xranges, yrange, **kwargs):
Returns
-------
:class:`matplotlib.collections.BrokenBarHCollection`
collection : A :class:`~.collections.BrokenBarHCollection`
Notes
-----
Expand Down Expand Up @@ -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*)
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/stackplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
"""
Expand Down