From 8f0f253aebd4cf31144d54b7e3c2c928613921be Mon Sep 17 00:00:00 2001 From: Tony S Yu Date: Sat, 16 Jul 2011 00:26:16 -0400 Subject: [PATCH] Fix docstring so Sphinx doesn't complain about indentation. Same indentation fix in 3 places, but only one warning fixed because 2 of the fixes are private functions. --- scikits/image/filter/tv_denoise.py | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/scikits/image/filter/tv_denoise.py b/scikits/image/filter/tv_denoise.py index f2987b55..557f529d 100644 --- a/scikits/image/filter/tv_denoise.py +++ b/scikits/image/filter/tv_denoise.py @@ -15,8 +15,9 @@ def _tv_denoise_3d(im, weight=100, eps=2.e-4, keep_type=False, n_iter_max=200): eps: float, optional relative difference of the value of the cost function that determines - the stop criterion. The algorithm stops when - (E_(n-1) - E_n) < eps * E_0 + the stop criterion. The algorithm stops when: + + (E_(n-1) - E_n) < eps * E_0 keep_type: bool, optional (False) whether the output has the same dtype as the input array. @@ -107,8 +108,9 @@ def _tv_denoise_2d(im, weight=50, eps=2.e-4, keep_type=False, n_iter_max=200): eps: float, optional relative difference of the value of the cost function that determines - the stop criterion. The algorithm stops when - (E_(n-1) - E_n) < eps * E_0 + the stop criterion. The algorithm stops when: + + (E_(n-1) - E_n) < eps * E_0 keep_type: bool, optional (False) whether the output has the same dtype as the input array. @@ -205,8 +207,9 @@ def tv_denoise(im, weight=50, eps=2.e-4, keep_type=False, n_iter_max=200): eps: float, optional relative difference of the value of the cost function that - determines the stop criterion. The algorithm stops when - (E_(n-1) - E_n) < eps * E_0 + determines the stop criterion. The algorithm stops when: + + (E_(n-1) - E_n) < eps * E_0 keep_type: bool, optional (False) whether the output has the same dtype as the input array.