Document visualizing_tests tool.

story645 · QuLogic · story645 · commit 8f748e1f56be · 2023-12-08T02:36:55.000-05:00
Co-authored-by: Elliott Sales de Andrade &lt;quantum.analyst@gmail.com&gt;
diff --git a/doc/devel/testing.rst b/doc/devel/testing.rst
@@ -59,6 +59,19 @@ not need to be installed, but Matplotlib should be)::
 
 .. _command-line parameters: http://doc.pytest.org/en/latest/usage.html
 
+Viewing image test output
+^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The output of :ref:`image-based <image-comparison>` tests is stored in a
+``result_images`` directory. These images can be compiled in an HTML page using the
+``visualize_tests`` tool::
+
+    python tools/visualize_tests.py
+
+Image test failures can be analysed using the ``triage_tests`` tool::
+
+    python tools/triage_tests.py
+
 
 Writing a simple test
 ---------------------
@@ -94,7 +107,9 @@ For numpy's default random number generator use::
 
 and then use ``rng`` when generating the random numbers.
 
-The seed is John Hunter's birthday.
+The seed is :ref:`John Hunter's <project_history>` birthday.
+
+.. _image-comparison:
 
 Writing an image comparison test
 --------------------------------
@@ -128,6 +143,10 @@ texts (labels, tick labels, etc) are not really part of what is tested, use
 ``remove_text=True`` as this will lead to smaller figures and reduce possible
 issues with font mismatch on different platforms.
 
+
+Compare two methods of creating an image
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
 Baseline images take a lot of space in the Matplotlib repository.
 An alternative approach for image comparison tests is to use the
 `~matplotlib.testing.decorators.check_figures_equal` decorator, which should be
