testing: fix docstring. add comments.

astraw · astraw · commit e0fce961abdd · 2009-09-23T06:24:27.000Z
svn path=/trunk/matplotlib/; revision=7816
diff --git a/lib/matplotlib/testing/decorators.py b/lib/matplotlib/testing/decorators.py
@@ -39,8 +39,8 @@ def failer(*args, **kwargs):
 def image_comparison(baseline_images=None):
     """
     compare images generated by the test with those specified in
-    *baseline_images*, which must correspond within tolerance *tol*,
-    else an ImageComparisonFailure exception will be raised.
+    *baseline_images*, which must correspond else an
+    ImageComparisonFailure exception will be raised.
 
     """
 
@@ -51,6 +51,11 @@ def decorated_compare_images(*args,**kwargs):
             result = func(*args,**kwargs)
             extension = '.png' # TODO: test more backends
             for fname in baseline_images:
+                # FIXME: place "actual", or current images, images in
+                # a more reasonable location than the current
+                # directory. Also, perhaps put them in sub-directory
+                # according to the name of the test module like the
+                # baseline images.
                 actual = fname + extension
 
                 # compute filename for baseline image
