Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -401,15 +401,15 @@ Whether to save result images for passing tests
| **kwarg**: ---
| **CLI**: ``--mpl-results-always``
| **INI**: ``mpl-results-always = <bool>``
| Default: ``False`` (``True`` if generating a HTML summary)
| Default: ``False`` (``True`` if generating an HTML summary)

By default, result images are only saved for tests that fail.
Enabling this option will force result images to be saved for all tests, even for tests that pass.

When this option is enabled, and some hash comparison tests are performed, a hash library containing all the result hashes will also be saved to the root of the results directory.
The filename will be extracted from ``--mpl-generate-hash-library``, ``--mpl-hash-library``, or ``hash_library=`` in that order.

This option is applied automatically when generating a HTML summary.
This option is applied automatically when generating an HTML summary.

.. rubric:: Relevance to "hybrid mode"

Expand All @@ -436,7 +436,7 @@ Multiple options can be specified comma-separated.
The available options are:

``html``
Generate a HTML summary report showing the test result, log entry and generated result image.
Generate an HTML summary report showing the test result, log entry and generated result image.
Results can be searched and filtered.
When in the (default) image comparison mode, the baseline image, diff image and RMS difference (if any), and RMS tolerance of each test will also be shown.
When in the hash comparison mode, the baseline hash and result hash will also be shown.
Expand All @@ -445,12 +445,12 @@ The available options are:
Generate a JSON summary report.
This format includes the same information as the HTML summary, but is more suitable for automated processing.
``basic-html``
Generate a HTML summary report with a simplified layout.
Generate an HTML summary report with a simplified layout.
This format does not include any JavaScript or need internet access to load web resources.

Summary reports can also be produced when generating baseline images and hash libraries.
The summaries will be written to the :ref:`results directory <results-path>`.
When generating a HTML summary, the ``--mpl-results-always`` option is automatically applied.
When generating an HTML summary, the ``--mpl-results-always`` option is automatically applied.
Therefore images for passing tests will also be shown.

For examples of how the summary reports look in different operating modes, see:
Expand Down
4 changes: 2 additions & 2 deletions docs/hash_mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ A better option is to generate baseline images along with the baseline hashes to
--mpl-generate-hash-library=your_project/tests/mpl35_ft261.json \
--mpl-generate-path=baseline

To assist with inspecting the generated images (and hashes), a HTML summary report can be generated by setting ``--mpl-generate-summary``:
To assist with inspecting the generated images (and hashes), an HTML summary report can be generated by setting ``--mpl-generate-summary``:

.. code-block:: bash

Expand All @@ -61,7 +61,7 @@ When running the tests, the ``--mpl`` flag should be used along with a :ref:`con
pytest --mpl \
--mpl-hash-library=your_project/tests/mpl35_ft261.json

Optionally, a HTML summary report can be generated by setting ``--mpl-generate-summary``:
Optionally, an HTML summary report can be generated by setting ``--mpl-generate-summary``:

.. code-block:: bash

Expand Down
4 changes: 2 additions & 2 deletions docs/image_mode.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ You should choose a directory within you repository to store the baseline images
The generated images should be checked to ensure they are as expected.
The images should then be committed to the repository.

To assist with inspecting the generated images, a HTML summary report can be generated by setting ``--mpl-generate-summary``:
To assist with inspecting the generated images, an HTML summary report can be generated by setting ``--mpl-generate-summary``:

.. code-block:: bash

Expand All @@ -48,7 +48,7 @@ When running the tests, the ``--mpl`` flag should be used to enable baseline ima
The :ref:`baseline path <baseline-dir>` should be set to the directory containing the baseline images.
If the baseline images are not found, the test will fail.

Optionally, a HTML summary report can be generated by setting ``--mpl-generate-summary``:
Optionally, an HTML summary report can be generated by setting ``--mpl-generate-summary``:

.. code-block:: bash

Expand Down
2 changes: 1 addition & 1 deletion pytest_mpl/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ def pytest_addoption(parser):

msg = (
"Always compare to baseline images and save result images, even for passing tests. "
"This option is automatically applied when generating a HTML summary."
"This option is automatically applied when generating an HTML summary."
)
option = "mpl-results-always"
group.addoption(f"--{option}", help=msg, action="store_true")
Expand Down
Loading