Commit45089d9

authored and

committed

DOC: clarify when to use multiple extensions

Co-authored-by: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>

1 parent670fb5a commit45089d9Copy full SHA for 45089d9

File tree

-1

lines changed

-1

lines changed

Lines changed: 6 additions & 1 deletion

Original file line number	Diff line number	Diff line change
`@@ -361,7 +361,12 @@ def check_figures_equal(*, extensions=("png", ), tol=0):`
`361`	`361`	`Parameters`
`362`	`362`	`----------`
`363`	`363`	`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.`
`365`	`370`	`tol : float`
`366`	`371`	`The RMS threshold above which the test is considered failed.`
`367`	`372`

Comments

(0)