Skip to content

Commit bd6a172

Browse files
committed
Merge pull request matplotlib#1870 from mdboom/doc/making-tests
Testing documentation isn't clear about which files to copy
2 parents 372fd71 + c6a0780 commit bd6a172

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

doc/devel/testing.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,10 +122,15 @@ it::
122122
The first time this test is run, there will be no baseline image to
123123
compare against, so the test will fail. Copy the output images (in
124124
this case `result_images/test_category/spines_axes_positions.*`) to
125-
the `baseline_images` tree in the source directory (in this case
126-
`lib/matplotlib/tests/baseline_images/test_category`) and put them
127-
under source code revision control (with `git add`). When rerunning
128-
the tests, they should now pass.
125+
the correct subdirectory of `baseline_images` tree in the source
126+
directory (in this case
127+
`lib/matplotlib/tests/baseline_images/test_category`). Note carefully
128+
the `.*` at the end: this will copy only the images we need to include
129+
in the `git` repository. The files ending in `_pdf.png` and
130+
`_svg.png` are converted from the `pdf` and `svg` originals on the fly
131+
and do not need to be in the respository. Put these new files under
132+
source code revision control (with `git add`). When rerunning the
133+
tests, they should now pass.
129134

130135
There are two optional keyword arguments to the `image_comparison`
131136
decorator:

0 commit comments

Comments
 (0)