8000 Cleanup parameter types in docstrings by timhoffm · Pull Request #17309 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

Cleanup parameter types in docstrings #17309

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
May 3, 2020
Merged

Cleanup parameter types in docstrings #17309

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion examples/lines_bars_and_markers/filled_step.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ def filled_hist(ax, edges, values, bottoms=None, orientation='v',
values : array
A length n array of bin counts or values

bottoms : scalar or array, optional
bottoms : float or array, optional
A length n array of the bottom of the bars. If None, zero is used.

orientation : {'v', 'h'}
Expand Down
86 changes: 41 additions & 45 deletions li 8000 b/matplotlib/axes/_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -708,7 +708,7 @@ def text(self, x, y, s, fontdict=None, **kwargs):

Parameters
----------
x, y : scalars
x, y : float
The position to place the text. By default, this is in data
coordinates. The coordinate system can be changed using the
*transform* parameter.
Expand Down Expand Up @@ -1123,14 +1123,14 @@ def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',

Parameters
----------
y : scalar or sequence of scalar
y : float or array-like
y-indexes where to plot the lines.

xmin, xmax : scalar or 1D array-like
xmin, xmax : float or array-like
Respective beginning and end of each line. If scalars are
provided, all lines will have same length.

colors : array-like of colors, default: 'k'
colors : list of colors, default: 'k'

linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional

Expand Down Expand Up @@ -1205,14 +1205,14 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',

Parameters
----------
x : scalar or 1D array-like
x : float or array-like
x-indexes where to plot the lines.

ymin, ymax : scalar or 1D array-like
ymin, ymax : float or array-like
Respective beginning and end of each line. If scalars are
provided, all lines will have same length.

colors : array-like of colors, default: 'k'
colors : list of colors, default: 'k'

linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional

Expand Down Expand Up @@ -1312,28 +1312,28 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
- 'vertical': the lines are arranged vertically in columns,
and are horizontal.

lineoffsets : scalar or sequence of scalars, default: 1
lineoffsets : float or array-like, default: 1
The offset of the center of the lines from the origin, in the
direction orthogonal to *orientation*.

A sequence must match the dimension of *positions*
in the direction of *orientation*.

linelengths : scalar or sequence of scalars, default: 1
linelengths : float or array-like, default: 1
The total height of the lines (i.e. the lines stretches from
``lineoffset - linelength/2`` to ``lineoffset + linelength/2``).

If a sequence, then *positions* must be 2D and the length
must match the first dimension of *positions*.

linewidths : scalar, scalar sequence or None, default: None
linewidths : float or array-like or None, default: None
The line width(s) of the event lines, in points. If it is None,
defaults to its rcParams setting.

If a sequence, then *positions* must be 2D and the length
must match the first dimension of *positions*.

colors : color, sequence of colors or None, default: None
colors : color or list of colors or None, default: None
The color(s) of the event lines. If it is None, defaults to its
rcParams setting.

Expand Down Expand Up @@ -3163,10 +3163,10 @@ def errorbar(self, x, y, yerr=None, xerr=None,

Parameters
----------
x, y : scalar or array-like
x, y : float or array-like
The data positions.

xerr, yerr : scalar or array-like, shape(N,) or shape(2, N), optional
xerr, yerr : float or array-like, shape(N,) or shape(2, N), optional
The errorbar sizes:

- scalar: Symmetric +/- values for all data points.
Expand All @@ -3192,14 +3192,14 @@ def errorbar(self, x, y, yerr=None, xerr=None,
The color of the errorbar lines. If None, use the color of the
line connecting the markers.

elinewidth : scalar, default: None
elinewidth : float, default: None
The linewidth of the errorbar lines. If None, the linewidth of
the current style is used.

capsize : scalar, default: :rc:`errorbar.capsize`
capsize : float, default: :rc:`errorbar.capsize`
The length of the error bar caps in points.

capthick : scalar, default: None
capthick : float, default: None
An alias to the keyword argument *markeredgewidth* (a.k.a. *mew*).
This setting is a more sensible name for the property that
controls the thickness of the error bar cap in points. For
Expand Down Expand Up @@ -3625,7 +3625,7 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
automatically set to match the positions. Defaults to
``range(1, N+1)`` where N is the number of boxes to be drawn.

widths : scalar or array-like
widths : float or array-like
Sets the width of each box either with a scalar or a
sequence. The default is 0.5, or ``0.15*(distance between
extreme positions)``, if that is smaller.
Expand All @@ -3652,7 +3652,7 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
*meanprops* (see below). Not recommended if *shownotches* is also
True. Otherwise, means will be shown as points.

zorder : scalar, default: None
zorder : float, default: ``Line2D.zorder = 2``
Sets the zorder of the boxplot.

Returns
Expand Down Expand Up @@ -3928,7 +3928,7 @@ def bxp(self, bxpstats, positions=None, widths=None, vert=True,
If True, the tick locations and labels will be adjusted to match the
boxplot positions.

zorder : scalar, default: None
zorder : float, default: ``Line2D.zorder = 2``
The zorder of the resulting boxplot.

Returns
Expand Down Expand Up @@ -4346,14 +4346,14 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,

Parameters
----------
x, y : scalar or array-like, shape (n, )
x, y : float or array-like, shape (n, )
The data positions.

s : scalar or array-like, shape (n, ), optional
s : float or array-like, shape (n, ), optional
The marker size in points**2.
Default is ``rcParams['lines.markersize'] ** 2``.

c : color, sequence, or sequence of colors, optional
c : color or list of colors or array-like, optional
The marker color. Possible values:

- A single color format string.
Expand Down Expand Up @@ -4391,16 +4391,16 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
*cmap*.
If *None*, use the default `.colors.Normalize`.

vmin, vmax : scalar, default: None
vmin, vmax : float, default: None
*vmin* and *vmax* are used in conjunction with the default norm to
map the color array *c* to the colormap *cmap*. If None, the
respective min and max of the color array is used.
It is deprecated to use *vmin*/*vmax* when *norm* is given.

alpha : scalar, default: None
alpha : float, default: None
The alpha blending value, between 0 (transparent) and 1 (opaque).

linewidths : scalar or array-like, default: :rc:`lines.linewidth`
linewidths : float or array-like, default: :rc:`lines.linewidth`
The linewidth of the marker edges. Note: The default *edgecolors*
is 'face'. You may want to change this as well.

Expand Down Expand Up @@ -5433,12 +5433,12 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
which can be set by *filterrad*. Additionally, the antigrain image
resize filter is controlled by the parameter *filternorm*.

alpha : scalar or array-like, optional
alpha : float or array-like, optional
The alpha blending value, between 0 (transparent) and 1 (opaque).
If *alpha* is an array, the alpha blending values are applied pixel
by pixel, and *alpha* must have the same shape as *X*.

vmin, vmax : scalar, optional
vmin, vmax : float, optional
When using scalar data and no explicit *norm*, *vmin* and *vmax*
define the data range that the colormap covers. By default,
the colormap covers the complete value range of the supplied
Expand All @@ -5455,7 +5455,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
See the :doc:`/tutorials/intermediate/imshow_extent` tutorial for
examples and a more detailed description.

extent : scalars (left, right, bottom, top), optional
extent : floats (left, right, bottom, top), optional
The bounding box in data coordinates that the image will fill.
The image is stretched individually along x and y to fill the box.

Expand Down Expand Up @@ -5736,7 +5736,7 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,
colormap range [0, 1] for mapping to colors. By default, the data
range is mapped to the colorbar range using linear scaling.

vmin, vmax : scalar, default: None
vmin, vmax : float, default: None
The colorbar range. If *None*, suitable min/max values are
automatically chosen by the `~.Normalize` instance (defaults to
the respective min/max values of *C* in case of the default linear
Expand All @@ -5754,7 +5754,7 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,

The singular form *edgecolor* works as an alias.

alpha : scalar, default: None
alpha : float, default: None
The alpha blending value of the face color, between 0 (transparent)
and 1 (opaque). Note: The edgecolor is currently not affected by
this.
Expand Down Expand Up @@ -5967,7 +5967,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
colormap range [0, 1] for mapping to colors. By default, the data
range is mapped to the colorbar range using linear scaling.

vmin, vmax : scalar, default: None
vmin, vmax : float, default: None
The colorbar range. If *None*, suitable min/max values are
automatically chosen by the `~.Normalize` instance (defaults to
the respective min/max values of *C* in case of the default linear
Expand All @@ -5985,7 +5985,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,

The singular form *edgecolor* works as an alias.

alpha : scalar, default: None
alpha : float, default: None
The alpha blending value, between 0 (transparent) and 1 (opaque).

shading : {'flat', 'nearest', 'gouraud', 'auto'}, optional
Expand Down Expand Up @@ -6215,14 +6215,14 @@ def pcolorfast(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
colormap range [0, 1] for mapping to colors. By default, the data
range is mapped to the colorbar range using linear scaling.

vmin, vmax : scalar, default: None
vmin, vmax : float, default: None
The colorbar range. If *None*, suitable min/max values are
automatically chosen by the `~.Normalize` instance (defaults to
the respective min/max values of *C* in case of the default linear
scaling).
It is deprecated to use *vmin*/*vmax* when *norm* is given.

alpha : scalar, default: None
alpha : float, default: None
The alpha blending value, between 0 (transparent) and 1 (opaque).

snap : bool, default: False
Expand Down Expand Up @@ -6486,7 +6486,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
If 'horizontal', `~.Axes.barh` will be used for bar-type histograms
and the *bottom* kwarg will be the left edges.

rwidth : scalar or None, default: None
rwidth : float or None, default: None
The relative width of the bars as a fraction of the bin width. If
``None``, automatically compute the width.

Expand Down Expand Up @@ -6856,15 +6856,11 @@ def hist2d(self, x, y, bins=10, range=None, density=False, weights=None,
weights : array-like, shape (n, ), optional
An array of values w_i weighing each sample (x_i, y_i).

cmin : scalar, default: None
All bins that has count less than cmin will not be displayed (set
to NaN before passing to imshow) and these count values in the
return value count histogram will also be set to nan upon return.

cmax : scalar, default: None
All bins that has count more than cmax will not be displayed (set
to NaN before passing to imshow) and these count values in the
return value count histogram will also be set to nan upon return.
cmin, cmax : float, default: None
All bins that has count less than *cmin* or more than *cmax* will
not be displayed (set to NaN before passing to imshow) and these
count values in the return value count histogram will also be set
to nan upon return.

Returns
-------
Expand Down Expand Up @@ -7798,7 +7794,7 @@ def violinplot(self, dataset, positions=None, vert=True, widths=0.5,
which stands for the quantiles that will be rendered for that
violin.

points : scalar, default: 100
points : int, default: 100
Defines the number of points to evaluate each of the
gaussian kernel density estimations at.

Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/axes/_base.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3509,7 +3509,7 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
Whether to turn on autoscaling of the y-axis. *True* turns on,
*False* turns off, *None* leaves unchanged.

ymin, ymax : scalar, optional
ymin, ymax : float, optional
They are equivalent to bottom and top respectively,
and it is an error to pass both *ymin* and *bottom* or
*ymax* and *top*.
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/axes/_secondary_axes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@ def set_ylabel(self, ylabel, fontdict=None, labelpad=None, **kwargs):
ylabel : str
The label text.

labelpad : scalar, default: ``self.yaxis.labelpad``
labelpad : float, default: ``self.yaxis.labelpad``
Spacing in points between the label and the y-axis.

Other Parameters
Expand Down
2 changes: 1 addition & 1 deletion lib/matplotlib/cbook/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1567,7 +1567,7 @@ def index_of(y):

Parameters
----------
y : scalar or array-like
y : float or array-like

Returns
-------
Expand Down
6 changes: 3 additions & 3 deletions lib/matplotlib/collections.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1474,15 +1474,15 @@ def __init__(self,
The orientation of the **collection** (the event bars are along
the orthogonal direction).

lineoffset : scalar, default: 0
lineoffset : float, default: 0
The offset of the center of the markers from the origin, in the
direction orthogonal to *orientation*.

linelength : scalar, default: 1
linelength : float, default: 1
The total height of the marker (i.e. the marker stretches from
``lineoffset - linelength/2`` to ``lineoffset + linelength/2``).

linewidth : scalar or None, default: None
linewidth : float or None, default: None
If it is None, defaults to its rcParams setting, in sequence form.

color : color, sequence of colors or None, default: None
Expand Down
4 changes: 2 additions & 2 deletions lib/matplotlib/colors.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1827,11 +1827,11 @@ def shade(self, data, cmap, norm=None, blend_mode='overlay', vmin=None,
``func(rgb, illum, **kwargs)``) Additional kwargs supplied
to this function will be passed on to the *blend_mode*
function.
vmin : scalar or None, optional
vmin : float or None, optional
The minimum value used in colormapping *data*. If *None* the
minimum value in *data* is used. If *norm* is specified, then this
argument will be ignored.
vmax : scalar or None, optional
vmax : float or None, optional
The maximum value used in colormapping *data*. If *None* the
maximum value in *data* is used. If *norm* is specified, then this
argument will be ignored.
Expand Down
Loading
0