DOC: note lack of unit handling in docstring

jklymak · jklymak · commit 99fab6a9aeb0 · 2023-12-03T09:06:48.000-08:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1978,7 +1978,8 @@ def acorr(self, x, **kwargs):
 
         Parameters
         ----------
-        x : array-like
+        x : array-like.  x is not run through Matplotlib's unit
+            conversion, so this should be a unit-less array.
 
         detrend : callable, default: `.mlab.detrend_none` (no detrending)
             A detrending function applied to *x*.  It must have the
@@ -2055,7 +2056,9 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
 
         Parameters
         ----------
-        x, y : array-like of length n
+        x, y : array-like of length n.  Neither x nor y are run through
+            Matplotlib's unit conversion, so these should be unit-less
+            arrays.
 
         detrend : callable, default: `.mlab.detrend_none` (no detrending)
             A detrending function applied to *x* and *y*.  It must have the
