[Numpy-svn] r3440 - trunk/numpy/core

[numpy-svn at scipy.org]

Author: oliphant
Date: 2006-11-16 18:33:28 -0600 (Thu, 16 Nov 2006)
New Revision: 3440

Modified:
   trunk/numpy/core/numeric.py
Log:
Add docstring to correlate.

Modified: trunk/numpy/core/numeric.py
===================================================================
--- trunk/numpy/core/numeric.py	2006-11-17 00:28:50 UTC (rev 3439)
+++ trunk/numpy/core/numeric.py	2006-11-17 00:33:28 UTC (rev 3440)
@@ -207,6 +207,10 @@
     return mode
 
 def correlate(a,v,mode='valid'):
+    """Return the discrete, linear correlation of 1-D sequences
+    a and v; mode can be 0 (valid), 1 (same), or 2 (full)
+    to specify the size of the resulting sequence
+    """
     mode = _mode_from_name(mode)
     return multiarray.correlate(a,v,mode)