improve docstring of Axes.step #10276
Conversation
542a427 to
3c93379
Compare
lib/matplotlib/axes/_axes.py
Outdated
| @@ -4992,16 +5018,18 @@ def fill_between(self, x, y1, y2=0, where=None, interpolate=False, | |||
| Setting *interpolate* to *True* will calculate the actual | |||
| interscection point and extend the filled region up to this point. | |||
|
|
|||
| step : {'pre', 'post', 'mid'}, optional | |||
| step : [ 'pre' | 'post' | 'mid' ], optional | |||
There was a problem hiding this comment.
The way this was is the numpydoc specified way of listing enumerated values, I think we should be moving to that style and away from the [ | ] style (unless I have missed something.
There was a problem hiding this comment.
Is this consensus? The documentation guide is still using [ | ] in its examples.
There was a problem hiding this comment.
I'd say it should be updated then.
lib/matplotlib/axes/_axes.py
Outdated
| @@ -1931,37 +1931,63 @@ def step(self, x, y, *args, **kwargs): | |||
| """ | |||
| Make a step plot. | |||
|
|
|||
| Call signatures:: | |||
|
|
|||
| plot(x, y, [fmt], data=None, where='pre', **kwargs) | |||
There was a problem hiding this comment.
data should probably go after kwargs as it is a keyword-only argument.
There was a problem hiding this comment.
But that might look odd, since the **kwargs form has to be at the end when one actually calls a function. I would put data after where, since data is more generic, but I wouldn't put it after **kwargs
There was a problem hiding this comment.
In 3.6 you can put keywords after kwargs :)
In [5]: def foo(**kwargs): print(kwargs)
In [6]: foo(**{'a': 'a', 'b': 'b'}, c='c')
{'a': 'a', 'b': 'b', 'c': 'c'}There was a problem hiding this comment.
That'd be a bit awkward. AFAIK, explicit arguments are not allowed after **kwargs in a signature (try def f(**kw, a=None)). I can switch to the Python 3 syntax plot(x, y, [fmt], *, data=None, where='pre', **kwargs).
3c93379 to
abdf672
Compare
abdf672 to
311ae7f
Compare
lib/matplotlib/axes/_axes.py
Outdated
| Call signatures:: | ||
|
|
||
| plot(x, y, [fmt], *, data=None, where='pre', **kwargs) | ||
| plot(x, y, [fmt], x2, y2, [fmt2], ..., *, where='pre', **kwargs) |
lib/matplotlib/axes/_axes.py
Outdated
|
|
||
| data : indexable object, optional | ||
| An object with labelled data. If given, provide the label names to | ||
| plot in x and y. |
lib/matplotlib/axes/_axes.py
Outdated
| - 'post': The y value is continued constantly to the right from | ||
| every *x* position, i.e. the interval ``[x[i], x[i+1])`` has the | ||
| value ``y[i]``. | ||
| - 'mid': Steps occur in the half-way between the *x* positions. |
lib/matplotlib/axes/_axes.py
Outdated
| - 'mid': Steps occur in the middle between the *x* positions. | ||
| every *x* position, i.e. the interval ``[x[i], x[i+1])`` has the | ||
| value ``y[i]``. | ||
| - 'mid': Steps occur in the half-way between the *x* positions. |
lib/matplotlib/axes/_axes.py
Outdated
| @@ -5173,16 +5201,18 @@ def fill_betweenx(self, y, x1, x2=0, where=None, | |||
| Setting *interpolate* to *True* will calculate the actual | |||
| interscection point and extend the filled region up to this point. | |||
|
|
|||
| step : {'pre', 'post', 'mid'}, optional | |||
| step : [ 'pre', 'post', 'mid' ], optional | |||
lib/matplotlib/axes/_axes.py
Outdated
| - 'post': The y value is continued constantly to the right from | ||
| every *x* position, i.e. the interval ``[x[i], x[i+1])`` has the | ||
| value ``y[i]``. | ||
| - 'mid': Steps occur in the half-way between the *x* positions. |
311ae7f to
b3fa851
Compare
PR Summary
As part of #10148: Docstring update for
Axes.step.