Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 07ed125

Browse files
committed
DOC: note lack of unit handling in docstring
1 parent 151199a commit 07ed125

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1978,7 +1978,9 @@ def acorr(self, x, **kwargs):
19781978
19791979
Parameters
19801980
----------
1981-
x : array-like
1981+
x : array-like.
1982+
Not run through Matplotlib's unit conversion, so this should
1983+
be a unit-less array.
19821984
19831985
detrend : callable, default: `.mlab.detrend_none` (no detrending)
19841986
A detrending function applied to *x*. It must have the
@@ -2055,7 +2057,9 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
20552057
20562058
Parameters
20572059
----------
2058-
x, y : array-like of length n
2060+
x, y : array-like of length n.
2061+
Neither *x* nor *y* are run through Matplotlib's unit conversion, so
2062+
these should be unit-less arrays.
20592063
20602064
detrend : callable, default: `.mlab.detrend_none` (no detrending)
20612065
A detrending function applied to *x* and *y*. It must have the

0 commit comments

Comments
 (0)