Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit fb41a33

Browse filesBrowse files
timhoffmtimhoffm
committed
Use float instead of scalar as type in docstrings
1 parent f843ffd commit fb41a33
Copy full SHA for fb41a33

File tree

16 files changed

+117
-120
lines changed
Filter options

16 files changed

+117
-120
lines changed

‎examples/lines_bars_and_markers/filled_step.py

Copy file name to clipboardExpand all lines: examples/lines_bars_and_markers/filled_step.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ def filled_hist(ax, edges, values, bottoms=None, orientation='v',
3535
values : array
3636
A length n array of bin counts or values
3737
38-
bottoms : scalar or array, optional
38+
bottoms : float or array, optional
3939
A length n array of the bottom of the bars. If None, zero is used.
4040
4141
orientation : {'v', 'h'}

‎lib/matplotlib/axes/_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_axes.py
+41-45Lines changed: 41 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -708,7 +708,7 @@ def text(self, x, y, s, fontdict=None, **kwargs):
708708
709709
Parameters
710710
----------
711-
x, y : scalars
711+
x, y : float
712712
The position to place the text. By default, this is in data
713713
coordinates. The coordinate system can be changed using the
714714
*transform* parameter.
@@ -1123,14 +1123,14 @@ def hlines(self, y, xmin, xmax, colors='k', linestyles='solid',
11231123
11241124
Parameters
11251125
----------
1126-
y : scalar or sequence of scalar
1126+
y : float or array-like
11271127
y-indexes where to plot the lines.
11281128
1129-
xmin, xmax : scalar or 1D array-like
1129+
xmin, xmax : float or array-like
11301130
Respective beginning and end of each line. If scalars are
11311131
provided, all lines will have same length.
11321132
1133-
colors : array-like of colors, default: 'k'
1133+
colors : list of colors, default: 'k'
11341134
11351135
linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
11361136
@@ -1205,14 +1205,14 @@ def vlines(self, x, ymin, ymax, colors='k', linestyles='solid',
12051205
12061206
Parameters
12071207
----------
1208-
x : scalar or 1D array-like
1208+
x : float or array-like
12091209
x-indexes where to plot the lines.
12101210
1211-
ymin, ymax : scalar or 1D array-like
1211+
ymin, ymax : float or array-like
12121212
Respective beginning and end of each line. If scalars are
12131213
provided, all lines will have same length.
12141214
1215-
colors : array-like of colors, default: 'k'
1215+
colors : list of colors, default: 'k'
12161216
12171217
linestyles : {'solid', 'dashed', 'dashdot', 'dotted'}, optional
12181218
@@ -1312,28 +1312,28 @@ def eventplot(self, positions, orientation='horizontal', lineoffsets=1,
13121312
- 'vertical': the lines are arranged vertically in columns,
13131313
and are horizontal.
13141314
1315-
lineoffsets : scalar or sequence of scalars, default: 1
1315+
lineoffsets : float or array-like, default: 1
13161316
The offset of the center of the lines from the origin, in the
13171317
direction orthogonal to *orientation*.
13181318
13191319
A sequence must match the dimension of *positions*
13201320
in the direction of *orientation*.
13211321
1322-
linelengths : scalar or sequence of scalars, default: 1
1322+
linelengths : float or array-like, default: 1
13231323
The total height of the lines (i.e. the lines stretches from
13241324
``lineoffset - linelength/2`` to ``lineoffset + linelength/2``).
13251325
13261326
If a sequence, then *positions* must be 2D and the length
13271327
must match the first dimension of *positions*.
13281328
1329-
linewidths : scalar, scalar sequence or None, default: None
1329+
linewidths : float or array-like or None, default: None
13301330
The line width(s) of the event lines, in points. If it is None,
13311331
defaults to its rcParams setting.
13321332
13331333
If a sequence, then *positions* must be 2D and the length
13341334
must match the first dimension of *positions*.
13351335
1336-
colors : color, sequence of colors or None, default: None
1336+
colors : color or list of colors or None, default: None
13371337
The color(s) of the event lines. If it is None, defaults to its
13381338
rcParams setting.
13391339
@@ -3163,10 +3163,10 @@ def errorbar(self, x, y, yerr=None, xerr=None,
31633163
31643164
Parameters
31653165
----------
3166-
x, y : scalar or array-like
3166+
x, y : float or array-like
31673167
The data positions.
31683168
3169-
xerr, yerr : scalar or array-like, shape(N,) or shape(2, N), optional
3169+
xerr, yerr : float or array-like, shape(N,) or shape(2, N), optional
31703170
The errorbar sizes:
31713171
31723172
- scalar: Symmetric +/- values for all data points.
@@ -3192,14 +3192,14 @@ def errorbar(self, x, y, yerr=None, xerr=None,
31923192
The color of the errorbar lines. If None, use the color of the
31933193
line connecting the markers.
31943194
3195-
elinewidth : scalar, default: None
3195+
elinewidth : float, default: None
31963196
The linewidth of the errorbar lines. If None, the linewidth of
31973197
the current style is used.
31983198
3199-
capsize : scalar, default: :rc:`errorbar.capsize`
3199+
capsize : float, default: :rc:`errorbar.capsize`
32003200
The length of the error bar caps in points.
32013201
3202-
capthick : scalar, default: None
3202+
capthick : float, default: None
32033203
An alias to the keyword argument *markeredgewidth* (a.k.a. *mew*).
32043204
This setting is a more sensible name for the property that
32053205
controls the thickness of the error bar cap in points. For
@@ -3625,7 +3625,7 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
36253625
automatically set to match the positions. Defaults to
36263626
``range(1, N+1)`` where N is the number of boxes to be drawn.
36273627
3628-
widths : scalar or array-like
3628+
widths : float or array-like
36293629
Sets the width of each box either with a scalar or a
36303630
sequence. The default is 0.5, or ``0.15*(distance between
36313631
extreme positions)``, if that is smaller.
@@ -3652,7 +3652,7 @@ def boxplot(self, x, notch=None, sym=None, vert=None, whis=None,
36523652
*meanprops* (see below). Not recommended if *shownotches* is also
36533653
True. Otherwise, means will be shown as points.
36543654
3655-
zorder : scalar, default: None
3655+
zorder : float, default: ``Line2D.zorder = 2``
36563656
Sets the zorder of the boxplot.
36573657
36583658
Returns
@@ -3928,7 +3928,7 @@ def bxp(self, bxpstats, positions=None, widths=None, vert=True,
39283928
If True, the tick locations and labels will be adjusted to match the
39293929
boxplot positions.
39303930
3931-
zorder : scalar, default: None
3931+
zorder : float, default: ``Line2D.zorder = 2``
39323932
The zorder of the resulting boxplot.
39333933
39343934
Returns
@@ -4346,14 +4346,14 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
43464346
43474347
Parameters
43484348
----------
4349-
x, y : scalar or array-like, shape (n, )
4349+
x, y : float or array-like, shape (n, )
43504350
The data positions.
43514351
4352-
s : scalar or array-like, shape (n, ), optional
4352+
s : float or array-like, shape (n, ), optional
43534353
The marker size in points**2.
43544354
Default is ``rcParams['lines.markersize'] ** 2``.
43554355
4356-
c : color, sequence, or sequence of colors, optional
4356+
c : color or list of colors or array-like, optional
43574357
The marker color. Possible values:
43584358
43594359
- A single color format string.
@@ -4391,16 +4391,16 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
43914391
*cmap*.
43924392
If *None*, use the default `.colors.Normalize`.
43934393
4394-
vmin, vmax : scalar, default: None
4394+
vmin, vmax : float, default: None
43954395
*vmin* and *vmax* are used in conjunction with the default norm to
43964396
map the color array *c* to the colormap *cmap*. If None, the
43974397
respective min and max of the color array is used.
43984398
It is deprecated to use *vmin*/*vmax* when *norm* is given.
43994399
4400-
alpha : scalar, default: None
4400+
alpha : float, default: None
44014401
The alpha blending value, between 0 (transparent) and 1 (opaque).
44024402
4403-
linewidths : scalar or array-like, default: :rc:`lines.linewidth`
4403+
linewidths : float or array-like, default: :rc:`lines.linewidth`
44044404
The linewidth of the marker edges. Note: The default *edgecolors*
44054405
is 'face'. You may want to change this as well.
44064406
@@ -5433,12 +5433,12 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
54335433
which can be set by *filterrad*. Additionally, the antigrain image
54345434
resize filter is controlled by the parameter *filternorm*.
54355435
5436-
alpha : scalar or array-like, optional
5436+
alpha : float or array-like, optional
54375437
The alpha blending value, between 0 (transparent) and 1 (opaque).
54385438
If *alpha* is an array, the alpha blending values are applied pixel
54395439
by pixel, and *alpha* must have the same shape as *X*.
54405440
5441-
vmin, vmax : scalar, optional
5441+
vmin, vmax : float, optional
54425442
When using scalar data and no explicit *norm*, *vmin* and *vmax*
54435443
define the data range that the colormap covers. By default,
54445444
the colormap covers the complete value range of the supplied
@@ -5455,7 +5455,7 @@ def imshow(self, X, cmap=None, norm=None, aspect=None,
54555455
See the :doc:`/tutorials/intermediate/imshow_extent` tutorial for
54565456
examples and a more detailed description.
54575457
5458-
extent : scalars (left, right, bottom, top), optional
5458+
extent : floats (left, right, bottom, top), optional
54595459
The bounding box in data coordinates that the image will fill.
54605460
The image is stretched individually along x and y to fill the box.
54615461
@@ -5736,7 +5736,7 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,
57365736
colormap range [0, 1] for mapping to colors. By default, the data
57375737
range is mapped to the colorbar range using linear scaling.
57385738
5739-
vmin, vmax : scalar, default: None
5739+
vmin, vmax : float, default: None
57405740
The colorbar range. If *None*, suitable min/max values are
57415741
automatically chosen by the `~.Normalize` instance (defaults to
57425742
the respective min/max values of *C* in case of the default linear
@@ -5754,7 +5754,7 @@ def pcolor(self, *args, shading=None, alpha=None, norm=None, cmap=None,
57545754
57555755
The singular form *edgecolor* works as an alias.
57565756
5757-
alpha : scalar, default: None
5757+
alpha : float, default: None
57585758
The alpha blending value of the face color, between 0 (transparent)
57595759
and 1 (opaque). Note: The edgecolor is currently not affected by
57605760
this.
@@ -5967,7 +5967,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
59675967
colormap range [0, 1] for mapping to colors. By default, the data
59685968
range is mapped to the colorbar range using linear scaling.
59695969
5970-
vmin, vmax : scalar, default: None
5970+
vmin, vmax : float, default: None
59715971
The colorbar range. If *None*, suitable min/max values are
59725972
automatically chosen by the `~.Normalize` instance (defaults to
59735973
the respective min/max values of *C* in case of the default linear
@@ -5985,7 +5985,7 @@ def pcolormesh(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
59855985
59865986
The singular form *edgecolor* works as an alias.
59875987
5988-
alpha : scalar, default: None
5988+
alpha : float, default: None
59895989
The alpha blending value, between 0 (transparent) and 1 (opaque).
59905990
59915991
shading : {'flat', 'nearest', 'gouraud', 'auto'}, optional
@@ -6215,14 +6215,14 @@ def pcolorfast(self, *args, alpha=None, norm=None, cmap=None, vmin=None,
62156215
colormap range [0, 1] for mapping to colors. By default, the data
62166216
range is mapped to the colorbar range using linear scaling.
62176217
6218-
vmin, vmax : scalar, default: None
6218+
vmin, vmax : float, default: None
62196219
The colorbar range. If *None*, suitable min/max values are
62206220
automatically chosen by the `~.Normalize` instance (defaults to
62216221
the respective min/max values of *C* in case of the default linear
62226222
scaling).
62236223
It is deprecated to use *vmin*/*vmax* when *norm* is given.
62246224
6225-
alpha : scalar, default: None
6225+
alpha : float, default: None
62266226
The alpha blending value, between 0 (transparent) and 1 (opaque).
62276227
62286228
snap : bool, default: False
@@ -6486,7 +6486,7 @@ def hist(self, x, bins=None, range=None, density=False, weights=None,
64866486
If 'horizontal', `~.Axes.barh` will be used for bar-type histograms
64876487
and the *bottom* kwarg will be the left edges.
64886488
6489-
rwidth : scalar or None, default: None
6489+
rwidth : float or None, default: None
64906490
The relative width of the bars as a fraction of the bin width. If
64916491
``None``, automatically compute the width.
64926492
@@ -6856,15 +6856,11 @@ def hist2d(self, x, y, bins=10, range=None, density=False, weights=None,
68566856
weights : array-like, shape (n, ), optional
68576857
An array of values w_i weighing each sample (x_i, y_i).
68586858
6859-
cmin : scalar, default: None
6860-
All bins that has count less than cmin will not be displayed (set
6861-
to NaN before passing to imshow) and these count values in the
6862-
return value count histogram will also be set to nan upon return.
6863-
6864-
cmax : scalar, default: None
6865-
All bins that has count more than cmax will not be displayed (set
6866-
to NaN before passing to imshow) and these count values in the
6867-
return value count histogram will also be set to nan upon return.
6859+
cmin, cmax : float, default: None
6860+
All bins that has count less than *cmin* or more than *cmax* will
6861+
not be displayed (set to NaN before passing to imshow) and these
6862+
count values in the return value count histogram will also be set
6863+
to nan upon return.
68686864
68696865
Returns
68706866
-------
@@ -7798,7 +7794,7 @@ def violinplot(self, dataset, positions=None, vert=True, widths=0.5,
77987794
which stands for the quantiles that will be rendered for that
77997795
violin.
78007796
7801-
points : scalar, default: 100
7797+
points : int, default: 100
78027798
Defines the number of points to evaluate each of the
78037799
gaussian kernel density estimations at.
78047800

‎lib/matplotlib/axes/_base.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_base.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3509,7 +3509,7 @@ def set_ylim(self, bottom=None, top=None, emit=True, auto=False,
35093509
Whether to turn on autoscaling of the y-axis. *True* turns on,
35103510
*False* turns off, *None* leaves unchanged.
35113511
3512-
ymin, ymax : scalar, optional
3512+
ymin, ymax : float, optional
35133513
They are equivalent to bottom and top respectively,
35143514
and it is an error to pass both *ymin* and *bottom* or
35153515
*ymax* and *top*.

‎lib/matplotlib/axes/_secondary_axes.py

Copy file name to clipboardExpand all lines: lib/matplotlib/axes/_secondary_axes.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -311,7 +311,7 @@ def set_ylabel(self, ylabel, fontdict=None, labelpad=None, **kwargs):
311311
ylabel : str
312312
The label text.
313313
314-
labelpad : scalar, default: ``self.yaxis.labelpad``
314+
labelpad : float, default: ``self.yaxis.labelpad``
315315
Spacing in points between the label and the y-axis.
316316
317317
Other Parameters

‎lib/matplotlib/cbook/__init__.py

Copy file name to clipboardExpand all lines: lib/matplotlib/cbook/__init__.py
+1-1Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1567,7 +1567,7 @@ def index_of(y):
15671567
15681568
Parameters
15691569
----------
1570-
y : scalar or array-like
1570+
y : float or array-like
15711571
15721572
Returns
15731573
-------

‎lib/matplotlib/collections.py

Copy file name to clipboardExpand all lines: lib/matplotlib/collections.py
+3-3Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1474,15 +1474,15 @@ def __init__(self,
14741474
The orientation of the **collection** (the event bars are along
14751475
the orthogonal direction).
14761476
1477-
lineoffset : scalar, default: 0
1477+
lineoffset : float, default: 0
14781478
The offset of the center of the markers from the origin, in the
14791479
direction orthogonal to *orientation*.
14801480
1481-
linelength : scalar, default: 1
1481+
linelength : float, default: 1
14821482
The total height of the marker (i.e. the marker stretches from
14831483
``lineoffset - linelength/2`` to ``lineoffset + linelength/2``).
14841484
1485-
linewidth : scalar or None, default: None
1485+
linewidth : float or None, default: None
14861486
If it is None, defaults to its rcParams setting, in sequence form.
14871487
14881488
color : color, sequence of colors or None, default: None

‎lib/matplotlib/colors.py

Copy file name to clipboardExpand all lines: lib/matplotlib/colors.py
+2-2Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1827,11 +1827,11 @@ def shade(self, data, cmap, norm=None, blend_mode='overlay', vmin=None,
18271827
``func(rgb, illum, **kwargs)``) Additional kwargs supplied
18281828
to this function will be passed on to the *blend_mode*
18291829
function.
1830-
vmin : scalar or None, optional
1830+
vmin : float or None, optional
18311831
The minimum value used in colormapping *data*. If *None* the
18321832
minimum value in *data* is used. If *norm* is specified, then this
18331833
argument will be ignored.
1834-
vmax : scalar or None, optional
1834+
vmax : float or None, optional
18351835
The maximum value used in colormapping *data*. If *None* the
18361836
maximum value in *data* is used. If *norm* is specified, then this
18371837
argument will be ignored.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.