Skip to content

Commit 6d9c808

Browse files
tacaswelltimhoffm
authored andcommitted
DOC: clarify when to use multiple extensions
Co-authored-by: Tim Hoffmann <[email protected]>
1 parent d393d23 commit 6d9c808

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

lib/matplotlib/testing/decorators.py

+6-1
Original file line numberDiff line numberDiff line change
@@ -361,7 +361,12 @@ def check_figures_equal(*, extensions=("png", ), tol=0):
361361
Parameters
362362
----------
363363
extensions : list, default: ["png"]
364-
The extensions to test.
364+
The extensions to test. Supported extensions are "png", "pdf", "svg".
365+
366+
Testing with the one default extension is sufficient if the output is not
367+
format dependent, e.g. if you test that a ``bar()`` plot yields the same
368+
result as some manually placed Rectangles. You should use all extensions
369+
if a renderer property is involved, e.g. correct alpha blending.
365370
tol : float
366371
The RMS threshold above which the test is considered failed.
367372

0 commit comments

Comments
 (0)