We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 4f448e3 commit fc450a1Copy full SHA for fc450a1
docs/index.rst
@@ -14,7 +14,11 @@
14
pytest-mpl |release| documentation
15
##################################
16
17
-This is a plugin to facilitate image comparison for Matplotlib figures in pytest.
+``pytest-mpl`` is a `pytest <https://docs.pytest.org>`__ plugin to facilitate image comparison for `Matplotlib <http://www.matplotlib.org>`__ figures.
18
+
19
+For each figure to test, an image is generated and then subtracted from an existing reference image.
20
+If the RMS of the residual is larger than a user-specified tolerance, the test will fail.
21
+Alternatively, the generated image can be hashed and compared to an expected value.
22
23
************
24
Installation
0 commit comments