Merge pull request #12004 from ColCarroll/update-acorr-doc

jklymak · web-flow · commit 3fdf3c0712b9 · 2018-09-02T13:33:06.000-07:00
Update acorr and xcorr docs to match numpy docs
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -1885,7 +1885,7 @@ def acorr(self, x, **kwargs):
         Notes
         -----
         The cross correlation is performed with :func:`numpy.correlate` with
-        ``mode = 2``.
+        ``mode = "full"``.
         """
         return self.xcorr(x, x, **kwargs)
 
@@ -1946,7 +1946,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
         Notes
         -----
         The cross correlation is performed with :func:`numpy.correlate` with
-        ``mode = 2``.
+        ``mode = "full"``.
         """
         Nx = len(x)
         if Nx != len(y):
@@ -1955,7 +1955,7 @@ def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
         x = detrend(np.asarray(x))
         y = detrend(np.asarray(y))
 
-        correls = np.correlate(x, y, mode=2)
+        correls = np.correlate(x, y, mode="full")
 
         if normed:
             correls /= np.sqrt(np.dot(x, x) * np.dot(y, y))
