8000 update step function documentation · matplotlib/matplotlib@22b79d3 · GitHub
[go: up one dir, main page]

Skip to content

Commit 22b79d3

Browse files
hkucukdereliNelleV
authored andcommitted
update step function documentation
1 parent 6f1c68e commit 22b79d3

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1810,19 +1810,24 @@ def step(self, x, y, *args, **kwargs):
18101810
"""
18111811
Make a step plot.
18121812
1813-
Call signature::
1814-
1815-
step(x, y, *args, **kwargs)
1816-
1817-
Additional keyword args to :func:`step` are the same as those
1818-
for :func:`~matplotlib.pyplot.plot`.
1813+
Parameters
1814+
----------
1815+
x : array_like
1816+
1-D sequence, and it is assumed, but not checked,
1817+
that it is uniformly increasing.
18191818
1820-
*x* and *y* must be 1-D sequences, and it is assumed, but not checked,
1821-
that *x* is uniformly increasing.
1819+
y : array_like
1820+
1-D sequence, and it is assumed, but not checked,
1821+
that it is uniformly increasing.
18221822
1823-
Keyword arguments:
1823+
Returns
1824+
-------
1825+
out : list
1826+
List of lines that were added.
18241827
1825-
*where*: [ 'pre' | 'post' | 'mid' ]
1828+
Other parameters
1829+
---------------------
1830+
where : [ 'pre' | 'post' | 'mid' ]
18261831
If 'pre' (the default), the interval from x[i] to x[i+1] has level
18271832
y[i+1].
18281833
@@ -1831,7 +1836,10 @@ def step(self, x, y, *args, **kwargs):
18311836
If 'mid', the jumps in *y* occur half-way between the
18321837
*x*-values.
18331838
1834-
Return value is a list of lines that were added.
1839+
Note
1840+
----
1841+
Additional parameters are the same as those for :func:`~matplotlib.pyplot.plot`.
1842+
18351843
"""
18361844

18371845
where = kwargs.pop('where', 'pre')

0 commit comments

Comments
 (0)
0