Skip to content

Docstring cleanups around DATA_PARAMETER_PLACEHOLDER. #21140

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.

Sign up for GitHub

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 1 commit into from
Sep 22, 2021
+15 −47
Merged

Docstring cleanups around DATA_PARAMETER_PLACEHOLDER. #21140

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 15 additions & 47 deletions lib/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,18 +1745,13 @@ def loglog(self, *args, **kwargs):
Non-positive values can be masked as invalid, or clipped to a very
small positive number.

**kwargs
All parameters supported by `.plot`.

Returns
-------
list of `.Line2D`
Objects representing the plotted data.

Other Parameters
----------------
data : indexable object, optional
DATA_PARAMETER_PLACEHOLDER

**kwargs
All parameters supported by `.plot`.
"""
dx = {k: v for k, v in kwargs.items()
if k in ['base', 'subs', 'nonpositive',
Expand Down Expand Up @@ -1801,18 +1796,13 @@ def semilogx(self, *args, **kwargs):
Non-positive values in x can be masked as invalid, or clipped to a
very small positive number.

**kwargs
All parameters supported by `.plot`.

Returns
-------
list of `.Line2D`
Objects representing the plotted data.

Other Parameters
----------------
data : indexable object, optional
DATA_PARAMETER_PLACEHOLDER

**kwargs
All parameters supported by `.plot`.
"""
d = {k: v for k, v in kwargs.items()
if k in ['base', 'subs', 'nonpositive',
Expand Down Expand Up @@ -1853,18 +1843,13 @@ def semilogy(self, *args, **kwargs):
Non-positive values in y can be masked as invalid, or clipped to a
very small positive number.

**kwargs
All parameters supported by `.plot`.

Returns
-------
list of `.Line2D`
Objects representing the plotted data.

Other Parameters
----------------
data : indexable object, optional
DATA_PARAMETER_PLACEHOLDER

**kwargs
All parameters supported by `.plot`.
"""
d = {k: v for k, v in kwargs.items()
if k in ['base', 'subs', 'nonpositive',
Expand Down Expand Up @@ -2098,10 +2083,6 @@ def step(self, x, y, *args, where='pre', data=None, **kwargs):
and plotted on the given positions, however, this is a rarely
needed feature for step plots.

data : indexable object, optional
An object with labelled data. If given, provide the label names to
plot in *x* and *y*.

where : {'pre', 'post', 'mid'}, default: 'pre'
Define where the steps should be placed:

Expand All @@ -2113,22 +2094,17 @@ def step(self, x, y, *args, where='pre', data=None, **kwargs):
value ``y[i]``.
- 'mid': Steps occur half-way between the *x* positions.

Returns
-------
list of `.Line2D`
Objects representing the plotted data.

Other Parameters
----------------
data : indexable object, optional
DATA_PARAMETER_PLACEHOLDER
An object with labelled data. If given, provide the label names to
plot in *x* and *y*.

**kwargs
Additional parameters are the same as those for `.plot`.

Notes
-----
.. [notes section required to get data note injection right]
Returns
-------
list of `.Line2D`
Objects representing the plotted data.
"""
_api.check_in_list(('pre', 'post', 'mid'), where=where)
kwargs['drawstyle'] = 'steps-' + where
Expand Down Expand Up @@ -5148,10 +5124,6 @@ def _fill_between_x_or_y(
--------
fill_between : Fill between two sets of y-values.
fill_betweenx : Fill between two sets of x-values.

Notes
-----
.. [notes section required to get data note injection right]
"""

dep_dir = {"x": "y", "y": "x"}[ind_dir]
Expand Down Expand Up @@ -6227,10 +6199,6 @@ def pcolorfast(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
**kwargs
Supported additional parameters depend on the type of grid.
See return types of *image* for further description.

Notes
-----
.. [notes section required to get data note injection right]
"""

C = args[-1]
Expand Down