8000 Merge pull request #7117 from NelleV/hkucukdereli_doc_update_fix · matplotlib/matplotlib@a40cad4 · GitHub
[go: up one dir, main page]

Skip to content

Commit a40cad4

Browse files
NelleVtacaswell
authored andcommitted
Merge pull request #7117 from NelleV/hkucukdereli_doc_update_fix
Step function docstring is now in numpydoc.
1 parent 77c4e28 commit a40cad4

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
@@ -1808,28 +1808,36 @@ def step(self, x, y, *args, **kwargs):
18081808
"""
18091809
Make a step plot.
18101810
1811-
Call signature::
1812-
1813-
step(x, y, *args, **kwargs)
1814-
1815-
Additional keyword args to :func:`step` are the same as those
1816-
for :func:`~matplotlib.pyplot.plot`.
1811+
Parameters
1812+
----------
1813+
x : array_like
1814+
1-D sequence, and it is assumed, but not checked,
1815+
that it is uniformly increasing.
18171816
1818-
*x* and *y* must be 1-D sequences, and it is assumed, but not checked,
1819-
that *x* is uniformly increasing.
1817+
y : array_like
1818+
1-D sequence, and it is assumed, but not checked,
1819+
that it is uniformly increasing.
18201820
1821-
Keyword arguments:
1821+
Returns
1822+
-------
1823+
list
1824+
List of lines that were added.
18221825
1823-
*where*: [ 'pre' | 'post' | 'mid' ]
1824-
If 'pre' (the default), the interval from x[i] to x[i+1] has level
1825-
y[i+1].
1826+
Other parameters
1827+
----------------
1828+
where : [ 'pre' | 'post' | 'mid' ]
1829+
If 'pre' (the default), the interval from
1830+
x[i] to x[i+1] has level y[i+1].
18261831
1827-
If 'post', that interval has level y[i].
1832+
If 'post', that interval has level y[i].
18281833
1829-
If 'mid', the jumps in *y* occur half-way between the
1830-
*x*-values.
1834+
If 'mid', the jumps in *y* occur half-way between the
1835+
*x*-values.
18311836
1832-
Return value is a list of lines that were added.
1837+
Notes
1838+
-----
1839+
Additional parameters are the same as those for
1840+
:func:`~matplotlib.pyplot.plot`.
18331841
"""
18341842

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

0 commit comments

Comments
 (0)
0