Merge pull request #11576 from dstansby/compare-doc

anntzer · web-flow · commit 17df3979a07a · 2018-07-05T14:04:35.000+02:00
Add parameter doc to save_diff_image
diff --git a/lib/matplotlib/testing/compare.py b/lib/matplotlib/testing/compare.py
@@ -451,6 +451,16 @@ def compare_images(expected, actual, tol, in_decorator=False):
 
 
 def save_diff_image(expected, actual, output):
+    '''
+    Parameters
+    ----------
+    expected : str
+        File path of expected image.
+    actual : str
+        File path of actual image.
+    output : str
+        File path to save difference image to.
+    '''
     # Drop alpha channels, similarly to compare_images.
     expectedImage = _png.read_png(expected)[..., :3]
     actualImage = _png.read_png(actual)[..., :3]
