From e6ef04049867f2174c766e2e81e27d79f531b44d Mon Sep 17 00:00:00 2001
From: Travis Oliphant <oliphant@enthought.com>
Date: Fri, 17 Nov 2006 00:33:28 +0000
Subject: Add docstring to correlate.

---
 numpy/core/numeric.py | 4 ++++
 1 file changed, 4 insertions(+)

(limited to 'numpy/core/numeric.py')

diff --git a/numpy/core/numeric.py b/numpy/core/numeric.py
index a9749b479..27f4a068c 100644
--- a/numpy/core/numeric.py
+++ b/numpy/core/numeric.py
@@ -207,6 +207,10 @@ def _mode_from_name(mode):
     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)
 
-- 
cgit v1.2.1