8000 PR #7030 rebased by NelleV · Pull Request #7117 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]

Skip to content

PR #7030 rebased #7117

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.

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 5 commits into from
Sep 15, 2016
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to lo 8000 ad files.
Loading
Diff view
Diff view
Next Next commit
update step function documentation
  • Loading branch information
hkucukdereli authored and NelleV committed Sep 15, 2016
commit 22b79d33df74de684a13205a380ca21aee143c64
30 changes: 19 additions & 11 deletions lib/matplotlib/axes/_axes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1810,19 +1810,24 @@ def step(self, x, y, *args, **kwargs):
"""
Make a step plot.

Call signature::

step(x, y, *args, **kwargs)

Additional keyword args to :func:`step` are the same as those
for :func:`~matplotlib.pyplot.plot`.
Parameters
----------
x : array_like
1-D sequence, and it is assumed, but not checked,
that it is uniformly increasing.

*x* and *y* must be 1-D sequences, and it is assumed, but not checked,
that *x* is uniformly increasing.
y : array_like
1-D sequence, and it is assumed, but not checked,
that it is uniformly increasing.

Keyword arguments:
Returns
-------
out : list
List of lines that were added.

*where*: [ 'pre' | 'post' | 'mid' ]
Other parameters
---------------------
where : [ 'pre' | 'post' | 'mid' ]
If 'pre' (the default), the interval from x[i] to x[i+1] has level
y[i+1].

Expand All @@ -1831,7 +1836,10 @@ def step(self, x, y, *args, **kwargs):
If 'mid', the jumps in *y* occur half-way between the
*x*-values.

Return value is a list of lines that were added.
Note
----
Additional parameters are the same as those for :func:`~matplotlib.pyplot.plot`.

"""

where = kwargs.pop('where', 'pre')
Expand Down
0