Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 4d511dc

Browse files
authored
Merge pull request #7117 from NelleV/hkucukdereli_doc_update_fix
Step function docstring is now in numpydoc.
2 parents 59c894c + 331d78d commit 4d511dc

File tree

1 file changed

+24
-16
lines changed

1 file changed

+24
-16
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 24 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1810,28 +1810,36 @@ 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+
list
1826+
List of lines that were added.
18241827
1825-
*where*: [ 'pre' | 'post' | 'mid' ]
1826-
If 'pre' (the default), the interval from x[i] to x[i+1] has level
1827-
y[i+1].
1828+
Other parameters
1829+
----------------
1830+
where : [ 'pre' | 'post' | 'mid' ]
1831+
If 'pre' (the default), the interval from
1832+
x[i] to x[i+1] has level y[i+1].
18281833
1829-
If 'post', that interval has level y[i].
1834+
If 'post', that interval has level y[i].
18301835
1831-
If 'mid', the jumps in *y* occur half-way between the
1832-
*x*-values.
1836+
If 'mid', the jumps in *y* occur half-way between the
1837+
*x*-values.
18331838
1834-
Return value is a list of lines that were added.
1839+
Notes
1840+
-----
1841+
Additional parameters are the same as those for
1842+
:func:`~matplotlib.pyplot.plot`.
18351843
"""
18361844

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

0 commit comments

Comments
 (0)