8000 DOC minor fixes on the documentation of errorbar by NelleV · Pull Request #1 · S-Alvanides/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC minor fixes on the documentation of errorbar #1

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
Sep 11, 2016
Merged

DOC minor fixes on the documentation of errorbar #1

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
21 changes: 10 additions & 11 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2725,35 +2725,35 @@ def errorbar(self, x, y, yerr=None, xerr=None,
A matplotlib color arg which gives the color the errorbar lines;
if None, use the color of the line connecting the markers.

elinewidth: scalar, optional, default: None
elinewidth : scalar, optional, default: None
The linewidth of the errorbar lines. If None, use the linewidth.

capsize: scalar, optional, default: None
capsize : scalar, optional, default: None
The length of the error bar caps in points; if None, it will
take the value from ``errorbar.capsize``
:data:`rcParam<matplotlib.rcParams>`.

capthick: scalar, optional, default: None
capthick : scalar, optional, default: None
An alias kwarg to markeredgewidth (a.k.a. - mew). This
setting is a more sensible name for the property that
controls the thickness of the error bar cap in points. For
backwards compatibility, if mew or markeredgewidth are given,
then they will over-ride capthick. This may change in future
releases.

barsabove: bool, optional, default: False
barsabove : bool, optional, default: False
if True , will plot the errorbars above the plot
symbols. Default is below.

lolims / uplims / xlolims / xuplims: bool, optional, default:None
lolims / uplims / xlolims / xuplims : bool, optional, default:None
These arguments can be used to indicate that a value gives
only upper/lower limits. In that case a caret symbol is
used to indicate this. lims-arguments may be of the same
type as *xerr* and *yerr*. To use limits with inverted
axes, :meth:`set_xlim` or :meth:`set_ylim` must be called
before :meth:`errorbar`.

errorevery: positive integer, optional, default:1
errorevery : positive integer, optional, default:1
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.
Expand All @@ -2762,11 +2762,10 @@ def errorbar(self, x, y, yerr=None, xerr=None,
-------
plotline : :class:`~matplotlib.lines.Line2D` instance
x, y plot markers and/or line
caplines :
list of error bar cap :class:`~matplotlib.lines.Line2D` instances
barlinecols :
list of :class:`~matplotlib.collections.LineCollection` instances
for the horizontal and vertical error ranges.
caplines : list of :class:`~matplotlib.lines.Line2D` instances
error bar cap
barlinecols : list of :class:`~matplotlib.collections.LineCollection` instances
horizontal and vertical error ranges.

Other Parameters
----------------
Expand Down
0