changed defaults on acorr and xcorr to norm, usevlines and maxlags=10

jdh2358 · jdh2358 · commit 1838008403a1 · 2009-01-21T19:09:15.000Z
svn path=/trunk/matplotlib/; revision=6815
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,7 @@
+2009-01-21 Changed the defaults of acorr and xcorr to use
+           usevlines=True, maxlags=10 and normed=True since these are
+           the best defaults
+
 2009-01-19 Fix bug in quiver argument handling. - EF
 
 2009-01-19 Fix bug in backend_gtk: don't delete nonexistent toolbar. - EF
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -19,20 +19,24 @@ list may help describe what changes may be necessary in your code.
 
 Changes for 0.98.x
 ==================
+
+* Changed the defaults of acorr and xcorr to use usevlines=True,
+  maxlags=10 and normed=True since these are the best defaults
+
 * Following keyword parameters for :class:`matplotlib.label.Label` are now
-  deprecated and new set of parameters are introduced. The new parameters 
-  are given as a fraction of the font-size. Also, *scatteryoffsets*, 
+  deprecated and new set of parameters are introduced. The new parameters
+  are given as a fraction of the font-size. Also, *scatteryoffsets*,
   *fancybox* and *columnspacing* are added as keyword parameters.
 
         ================   ================
         Deprecated         New
         ================   ================
-        pad                borderpad          
-        labelsep           labelspacing       
-        handlelen          handlelength       
-        handlestextsep     handletextpad      
-        axespad	           borderaxespad      
-        ================   ================   
+        pad                borderpad
+        labelsep           labelspacing
+        handlelen          handlelength
+        handlestextsep     handletextpad
+        axespad	           borderaxespad
+        ================   ================
 
 
 * Removed the configobj and experiemtnal traits rc support
diff --git a/lib/matplotlib/axes.py b/lib/matplotlib/axes.py
@@ -3543,8 +3543,8 @@ def acorr(self, x, **kwargs):
         """
         call signature::
 
-            acorr(x, normed=False, detrend=mlab.detrend_none, usevlines=False,
-                  maxlags=None, **kwargs)
+            acorr(x, normed=True, detrend=mlab.detrend_none, usevlines=True,
+                  maxlags=10, **kwargs)
 
         Plot the autocorrelation of *x*.  If *normed* = *True*,
         normalize the data by the autocorrelation at 0-th lag.  *x* is
@@ -3602,13 +3602,13 @@ def acorr(self, x, **kwargs):
         return self.xcorr(x, x, **kwargs)
     acorr.__doc__ = cbook.dedent(acorr.__doc__) % martist.kwdocd
 
-    def xcorr(self, x, y, normed=False, detrend=mlab.detrend_none,
-              usevlines=False, maxlags=None, **kwargs):
+    def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
+              usevlines=True, maxlags=10, **kwargs):
         """
         call signature::
 
-          xcorr(x, y, normed=False, detrend=mlab.detrend_none,
-                usevlines=False, **kwargs):
+            def xcorr(self, x, y, normed=True, detrend=mlab.detrend_none,
+              usevlines=True, maxlags=10, **kwargs):
 
         Plot the cross correlation between *x* and *y*.  If *normed* =
         *True*, normalize the data by the cross correlation at 0-th
