Skip to content

Commit 2522653

Browse files
committed
DOC: Fix type descriptions in fill_between docstring
Coerce to our standard type descriptions https://matplotlib.org/devdocs/devel/document.html#parameter-type-descriptions
1 parent 685ea2b commit 2522653

File tree

2 files changed

+12
-12
lines changed

2 files changed

+12
-12
lines changed

lib/matplotlib/axes/_axes.py

+4-4
Original file line numberDiff line numberDiff line change
@@ -5582,16 +5582,16 @@ def _fill_between_x_or_y(
55825582
55835583
Parameters
55845584
----------
5585-
{ind} : array (length N)
5585+
{ind} : array-like
55865586
The {ind} coordinates of the nodes defining the curves.
55875587
5588-
{dep}1 : array (length N) or scalar
5588+
{dep}1 : array-like or float
55895589
The {dep} coordinates of the nodes defining the first curve.
55905590
5591-
{dep}2 : array (length N) or scalar, default: 0
5591+
{dep}2 : array-like or float, default: 0
55925592
The {dep} coordinates of the nodes defining the second curve.
55935593
5594-
where : array of bool (length N), optional
5594+
where : array-like of bool, optional
55955595
Define *where* to exclude some {dir} regions from being filled.
55965596
The filled regions are defined by the coordinates ``{ind}[where]``.
55975597
More precisely, fill between ``{ind}[i]`` and ``{ind}[i+1]`` if

lib/matplotlib/collections.py

+8-8
Original file line numberDiff line numberDiff line change
@@ -1288,16 +1288,16 @@ def __init__(
12881288
- 'x': the curves are ``(t, f1)`` and ``(t, f2)``.
12891289
- 'y': the curves are ``(f1, t)`` and ``(f2, t)``.
12901290
1291-
t : array (length N)
1291+
t : array-like
12921292
The ``t_direction`` coordinates of the nodes defining the curves.
12931293
1294-
f1 : array (length N) or scalar
1294+
f1 : array-like or float
12951295
The other coordinates of the nodes defining the first curve.
12961296
1297-
f2 : array (length N) or scalar
1297+
f2 : array-like or float
12981298
The other coordinates of the nodes defining the second curve.
12991299
1300-
where : array of bool (length N), optional
1300+
where : array-like of bool, optional
13011301
Define *where* to exclude some {dir} regions from being filled.
13021302
The filled regions are defined by the coordinates ``t[where]``.
13031303
More precisely, fill between ``t[i]`` and ``t[i+1]`` if
@@ -1368,16 +1368,16 @@ def set_data(self, t, f1, f2, *, where=None):
13681368
13691369
Parameters
13701370
----------
1371-
t : array (length N)
1371+
t : array-like
13721372
The ``self.t_direction`` coordinates of the nodes defining the curves.
13731373
1374-
f1 : array (length N) or scalar
1374+
f1 : array-like or float
13751375
The other coordinates of the nodes defining the first curve.
13761376
1377-
f2 : array (length N) or scalar
1377+
f2 : array-like or float
13781378
The other coordinates of the nodes defining the second curve.
13791379
1380-
where : array of bool (length N), optional
1380+
where : array-like of bool, optional
13811381
Define *where* to exclude some {dir} regions from being filled.
13821382
The filled regions are defined by the coordinates ``t[where]``.
13831383
More precisely, fill between ``t[i]`` and ``t[i+1]`` if

0 commit comments

Comments
 (0)