Commitcb5463d

committed

DOC: note lack of unit handling in docstring [ci doc]

1 parent151199a commitcb5463dCopy full SHA for cb5463d

File tree

-0

lines changed

-0

lines changed

Lines changed: 4 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1979,6 +1979,8 @@ def acorr(self, x, **kwargs):`
`1979`	`1979`	`Parameters`
`1980`	`1980`	`----------`
`1981`	`1981`	`x : array-like`
	`1982`	`+ Not run through Matplotlib's unit conversion, so this should`
	`1983`	`+ be a unit-less array.`
`1982`	`1984`
`1983`	`1985`	detrend : callable, default: `.mlab.detrend_none` (no detrending)
`1984`	`1986`	`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,`
`2056`	`2058`	`Parameters`
`2057`	`2059`	`----------`
`2058`	`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.`
`2059`	`2063`
`2060`	`2064`	detrend : callable, default: `.mlab.detrend_none` (no detrending)
`2061`	`2065`	`A detrending function applied to x and y. It must have the`

Comments

(0)