Skip to content

Commit e4dca96

Browse files
committed
Add documentation on avoiding PytestReturnNotNoneWarning
1 parent 8ce4878 commit e4dca96

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

README.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,11 @@ and the tests will pass if the images are the same. If you omit the
120120
``--mpl`` option, the tests will run but will only check that the code
121121
runs, without checking the output images.
122122

123+
If pytest-mpl is not installed, the image comparison tests will cause pytest
124+
to show a warning, ``PytestReturnNotNoneWarning``. Installing pytest-mpl will
125+
solve this issue. Alternativly, the image comparison tests can be deselected
126+
by running pytest with ``-m "not mpl_image_compare"``.
127+
123128

124129
Generating a Test Summary
125130
^^^^^^^^^^^^^^^^^^^^^^^^^

docs/usage.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,3 +86,8 @@ against, the tests can be run with::
8686
and the tests will pass if the images are the same. If you omit the
8787
``--mpl`` option, the tests will run but will only check that the code
8888
runs, without checking the output images.
89+
90+
If pytest-mpl is not installed, the image comparison tests will cause pytest
91+
to show a warning, ``PytestReturnNotNoneWarning``. Installing pytest-mpl will
92+
solve this issue. Alternativly, the image comparison tests can be deselected
93+
by running pytest with ``-m "not mpl_image_compare"``.

0 commit comments

Comments
 (0)