Skip to content

Commit fc450a1

Browse files
committed
Add plugin description to index
1 parent 4f448e3 commit fc450a1

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

docs/index.rst

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,11 @@
1414
pytest-mpl |release| documentation
1515
##################################
1616

17-
This is a plugin to facilitate image comparison for Matplotlib figures in pytest.
17+
``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.
1822

1923
************
2024
Installation

0 commit comments

Comments
 (0)