Skip to content

Commit 592650e

Browse files
authored
Merge pull request #29458 from meeseeksmachine/auto-backport-of-pr-29457-on-v3.10.x
Backport PR #29457 on branch v3.10.x (DOC: Use float instead for scalar for type descriptions in docstrings)
2 parents fb59ff1 + 9b99010 commit 592650e

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

lib/matplotlib/artist.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1016,7 +1016,7 @@ def set_alpha(self, alpha):
10161016
10171017
Parameters
10181018
----------
1019-
alpha : scalar or None
1019+
alpha : float or None
10201020
*alpha* must be within the 0-1 range, inclusive.
10211021
"""
10221022
if alpha is not None and not isinstance(alpha, Real):
@@ -1035,7 +1035,7 @@ def _set_alpha_for_array(self, alpha):
10351035
10361036
Parameters
10371037
----------
1038-
alpha : array-like or scalar or None
1038+
alpha : array-like or float or None
10391039
All values must be within the 0-1 range, inclusive.
10401040
Masked values and nans are not supported.
10411041
"""

lib/matplotlib/axes/_axes.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1618,7 +1618,7 @@ def plot(self, *args, scalex=True, scaley=True, data=None, **kwargs):
16181618
16191619
Parameters
16201620
----------
1621-
x, y : array-like or scalar
1621+
x, y : array-like or float
16221622
The horizontal / vertical coordinates of the data points.
16231623
*x* values are optional and default to ``range(len(y))``.
16241624
@@ -4250,13 +4250,13 @@ def bxp(self, bxpstats, positions=None, widths=None, vert=None,
42504250
A list of dictionaries containing stats for each boxplot.
42514251
Required keys are:
42524252
4253-
- ``med``: Median (scalar).
4254-
- ``q1``, ``q3``: First & third quartiles (scalars).
4255-
- ``whislo``, ``whishi``: Lower & upper whisker positions (scalars).
4253+
- ``med``: Median (float).
4254+
- ``q1``, ``q3``: First & third quartiles (float).
4255+
- ``whislo``, ``whishi``: Lower & upper whisker positions (float).
42564256
42574257
Optional keys are:
42584258
4259-
- ``mean``: Mean (scalar). Needed if ``showmeans=True``.
4259+
- ``mean``: Mean (float). Needed if ``showmeans=True``.
42604260
- ``fliers``: Data beyond the whiskers (array-like).
42614261
Needed if ``showfliers=True``.
42624262
- ``cilo``, ``cihi``: Lower & upper confidence intervals
@@ -6891,7 +6891,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
68916891
``True``, then the histogram is normalized such that the first bin
68926892
equals 1.
68936893
6894-
bottom : array-like, scalar, or None, default: None
6894+
bottom : array-like or float, default: 0
68956895
Location of the bottom of each bin, i.e. bins are drawn from
68966896
``bottom`` to ``bottom + hist(x, bins)`` If a scalar, the bottom
68976897
of each bin is shifted by the same amount. If an array, each bin

lib/matplotlib/backend_bases.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -428,11 +428,11 @@ def draw_image(self, gc, x, y, im, transform=None):
428428
gc : `.GraphicsContextBase`
429429
A graphics context with clipping information.
430430
431-
x : scalar
431+
x : float
432432
The distance in physical units (i.e., dots or pixels) from the left
433433
hand side of the canvas.
434434
435-
y : scalar
435+
y : float
436436
The distance in physical units (i.e., dots or pixels) from the
437437
bottom side of the canvas.
438438

lib/matplotlib/backends/backend_mixed.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ def __init__(self, figure, width, height, dpi, vector_renderer,
2121
----------
2222
figure : `~matplotlib.figure.Figure`
2323
The figure instance.
24-
width : scalar
24+
width : float
2525
The width of the canvas in logical units
26-
height : scalar
26+
height : float
2727
The height of the canvas in logical units
2828
dpi : float
2929
The dpi of the canvas

lib/matplotlib/colors.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -717,7 +717,7 @@ def __call__(self, X, alpha=None, bytes=False):
717717
r"""
718718
Parameters
719719
----------
720-
X : float or int, `~numpy.ndarray` or scalar
720+
X : float or int or array-like
721721
The data value(s) to convert to RGBA.
722722
For floats, *X* should be in the interval ``[0.0, 1.0]`` to
723723
return the RGBA values ``X*100`` percent along the Colormap line.
@@ -745,7 +745,7 @@ def _get_rgba_and_mask(self, X, alpha=None, bytes=False):
745745
r"""
746746
Parameters
747747
----------
748-
X : float or int, `~numpy.ndarray` or scalar
748+
X : float or int or array-like
749749
The data value(s) to convert to RGBA.
750750
For floats, *X* should be in the interval ``[0.0, 1.0]`` to
751751
return the RGBA values ``X*100`` percent along the Colormap line.
@@ -1566,7 +1566,7 @@ def __call__(self, X, alpha=None, bytes=False):
15661566
r"""
15671567
Parameters
15681568
----------
1569-
X : tuple (X0, X1), X0 and X1: float or int `~numpy.ndarray` or scalar
1569+
X : tuple (X0, X1), X0 and X1: float or int or array-like
15701570
The data value(s) to convert to RGBA.
15711571
15721572
- For floats, *X* should be in the interval ``[0.0, 1.0]`` to

0 commit comments

Comments
 (0)