From c9fd1f3dd044af88d2e62ed6ca41b6a29f321ba4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= <hannesschoenberger@gmail.com>
Date: Sun, 9 Sep 2012 19:44:13 +0200
Subject: [PATCH] Add doc string to helper function _smooth

---
 skimage/transform/pyramids.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/skimage/transform/pyramids.py b/skimage/transform/pyramids.py
index 7a8e8228..458b8c20 100644
--- a/skimage/transform/pyramids.py
+++ b/skimage/transform/pyramids.py
@@ -6,8 +6,8 @@ from skimage.util import img_as_float
 
 
 def _smooth(image, sigma, mode, cval):
+    """Return image with each channel smoothed by the gaussian filter."""
 
-    # allocate output array
     smoothed = np.empty(image.shape, dtype=np.double)
 
     if image.ndim == 3: # apply gaussian filter to all dimensions independently