From 5458529ccf1b35f4273a1cca9bce5016cd13902c Mon Sep 17 00:00:00 2001 From: Thomas A Caswell Date: Wed, 22 Sep 2021 18:43:45 -0400 Subject: [PATCH] Backport PR #21140: Docstring cleanups around DATA_PARAMETER_PLACEHOLDER. --- lib/matplotlib/axes/_axes.py | 62 +++++++++--------------------------- 1 file changed, 15 insertions(+), 47 deletions(-) diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py index 66af3dd8038c..0ea820332175 100644 --- a/lib/matplotlib/axes/_axes.py +++ b/lib/matplotlib/axes/_axes.py @@ -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', @@ -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', @@ -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', @@ -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: @@ -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 @@ -5144,10 +5120,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] @@ -6215,10 +6187,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] pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy