Skip to content

Commit cb5463d

Browse files
committed
DOC: note lack of unit handling in docstring [ci doc]
1 parent 151199a commit cb5463d

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

lib/matplotlib/axes/_axes.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1979,6 +1979,8 @@ def acorr(self, x, **kwargs):
19791979
Parameters
19801980
----------
19811981
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
@@ -2056,6 +2058,8 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
20562058
Parameters
20572059
----------
20582060
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)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy