Clarify what happens when generating baseline hashes

matplotlib · Feb 16, 2022 · d4746bc · d4746bc
1 parent 7027739
commit d4746bc
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.rst b/README.rst
@@ -86,6 +86,10 @@ can either be specified via the ``--mpl-hash-library=`` command line argument,
 or via the ``hash_library=`` keyword argument to the
 ``@pytest.mark.mpl_image_compare`` decorator.
 
+When generating a hash library, the tests will also be run as usual against the
+existing hash library specified by ``--mpl-hash-library`` or the keyword argument.
+However, generating baseline images will always result in the tests being skipped.
+
 
 Hybrid Mode: Hashes and Images
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^