From b3c7d67ace9b3caeac3969a88cf62a1a19868fd7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Johannes=20Sch=C3=B6nberger?= <jschoenberger@demuc.de>
Date: Sun, 26 May 2013 10:38:20 +0200
Subject: [PATCH] Fix parameter descriptions of warp functions

---
 skimage/transform/_warps.py | 69 +++++++++++++++++++------------------
 1 file changed, 35 insertions(+), 34 deletions(-)

diff --git a/skimage/transform/_warps.py b/skimage/transform/_warps.py
index be7eee12..55aef002 100644
--- a/skimage/transform/_warps.py
+++ b/skimage/transform/_warps.py
@@ -24,13 +24,13 @@ def resize(image, output_shape, order=1, mode='constant', cval=0.):
 
     Other parameters
     ----------------
-    order : int
-        Order of splines used in interpolation.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    mode : string
-        How to handle values outside the image borders.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    cval : string
+    order : int, optional
+        The order of the spline interpolation, default is 3. The order has to
+        be in the range 0-5.
+    mode : string, optional
+        Points outside the boundaries of the input are filled according
+        to the given mode ('constant', 'nearest', 'reflect' or 'wrap').
+    cval : float, optional
         Used in conjunction with mode 'constant', the value outside
         the image boundaries.
 
@@ -95,13 +95,13 @@ def rescale(image, scale, order=1, mode='constant', cval=0.):
 
     Other parameters
     ----------------
-    order : int
-        Order of splines used in interpolation.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    mode : string
-        How to handle values outside the image borders.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    cval : string
+    order : int, optional
+        The order of the spline interpolation, default is 3. The order has to
+        be in the range 0-5.
+    mode : string, optional
+        Points outside the boundaries of the input are filled according
+        to the given mode ('constant', 'nearest', 'reflect' or 'wrap').
+    cval : float, optional
         Used in conjunction with mode 'constant', the value outside
         the image boundaries.
 
@@ -141,13 +141,13 @@ def rotate(image, angle, resize=False, order=1, mode='constant', cval=0.):
 
     Other parameters
     ----------------
-    order : int
-        Order of splines used in interpolation.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    mode : string
-        How to handle values outside the image borders.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    cval : string
+    order : int, optional
+        The order of the spline interpolation, default is 3. The order has to
+        be in the range 0-5.
+    mode : string, optional
+        Points outside the boundaries of the input are filled according
+        to the given mode ('constant', 'nearest', 'reflect' or 'wrap').
+    cval : float, optional
         Used in conjunction with mode 'constant', the value outside
         the image boundaries.
 
@@ -211,14 +211,14 @@ def swirl(image, center=None, strength=1, radius=100, rotation=0,
     ----------
     image : ndarray
         Input image.
-    center : (x,y) tuple or (2,) ndarray
+    center : (x,y) tuple or (2,) ndarray, optional
         Center coordinate of transformation.
-    strength : float
+    strength : float, optional
         The amount of swirling applied.
-    radius : float
+    radius : float, optional
         The extent of the swirl in pixels.  The effect dies out
         rapidly beyond `radius`.
-    rotation : float
+    rotation : float, optional
         Additional rotation applied to the image.
 
     Returns
@@ -228,15 +228,16 @@ def swirl(image, center=None, strength=1, radius=100, rotation=0,
 
     Other parameters
     ----------------
-    output_shape : tuple or ndarray
-        Size of the generated output image.
-    order : int
-        Order of splines used in interpolation.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    mode : string
-        How to handle values outside the image borders.  See
-        `scipy.ndimage.map_coordinates` for detail.
-    cval : string
+    output_shape : tuple (rows, cols), optional
+        Shape of the output image generated. By default the shape of the input
+        image is preserved.
+    order : int, optional
+        The order of the spline interpolation, default is 3. The order has to
+        be in the range 0-5.
+    mode : string, optional
+        Points outside the boundaries of the input are filled according
+        to the given mode ('constant', 'nearest', 'reflect' or 'wrap').
+    cval : float, optional
         Used in conjunction with mode 'constant', the value outside
         the image boundaries.