Skip to content

Commit e3cdff0

Browse files
committed
Make example commands multiline
1 parent fc450a1 commit e3cdff0

File tree

1 file changed

+35
-8
lines changed

1 file changed

+35
-8
lines changed

docs/summaries.rst

Lines changed: 35 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -30,63 +30,90 @@ summary can also be saved. Multiple options can be specified comma-separated.
3030

3131
.. code-block:: bash
3232
33-
pytest --mpl --mpl-results-path=results --mpl-generate-summary=html,json
33+
pytest --mpl \
34+
--mpl-results-path=results \
35+
--mpl-generate-summary=html,json
3436
3537
:summary:`test_html_images_only`
3638

3739
.. card:: Hash comparison only
3840

3941
.. code-block:: bash
4042
41-
pytest --mpl --mpl-hash-library=mpl35_ft261.json --mpl-results-path=results --mpl-generate-summary=html,json
43+
pytest --mpl \
44+
--mpl-hash-library=mpl35_ft261.json \
45+
--mpl-results-path=results \
46+
--mpl-generate-summary=html,json
4247
4348
:summary:`test_html_hashes_only`
4449

4550
.. card:: Hybrid mode: hash and image comparison
4651

4752
.. code-block:: bash
4853
49-
pytest --mpl --mpl-hash-library=mpl35_ft261.json --mpl-baseline-path=baseline --mpl-results-path=results --mpl-generate-summary=html,json
54+
pytest --mpl \
55+
--mpl-hash-library=mpl35_ft261.json \
56+
--mpl-baseline-path=baseline \
57+
--mpl-results-path=results \
58+
--mpl-generate-summary=html,json
5059
5160
:summary:`test_html`
5261

5362
.. card:: Generating baseline images and hashes (With no testing)
5463

5564
.. code-block:: bash
5665
57-
pytest --mpl --mpl-generate-path=baseline --mpl-generate-hash-library=test_hashes.json --mpl-results-path=results --mpl-generate-summary=html,json
66+
pytest --mpl \
67+
--mpl-generate-path=baseline \
68+
--mpl-generate-hash-library=test_hashes.json \
69+
--mpl-results-path=results \
70+
--mpl-generate-summary=html,json
5871
5972
:summary:`test_html_generate`
6073

6174
.. card:: Generating baseline images (With no testing)
6275

6376
.. code-block:: bash
6477
65-
pytest --mpl --mpl-generate-path=baseline --mpl-results-path=results --mpl-generate-summary=html,json
78+
pytest --mpl \
79+
--mpl-generate-path=baseline \
80+
--mpl-results-path=results \
81+
--mpl-generate-summary=html,json
6682
6783
:summary:`test_html_generate_images_only`
6884

6985
.. card:: Generating baseline hashes (With image comparison)
7086

7187
.. code-block:: bash
7288
73-
pytest --mpl --mpl-generate-hash-library=test_hashes.json --mpl-results-path=results --mpl-generate-summary=html,json
89+
pytest --mpl \
90+
--mpl-generate-hash-library=test_hashes.json \
91+
--mpl-results-path=results \
92+
--mpl-generate-summary=html,json
7493
7594
:summary:`test_html_generate_hashes_only`
7695

7796
.. card:: Generating baseline hashes (With hash comparison)
7897

7998
.. code-block:: bash
8099
81-
pytest --mpl --mpl-generate-hash-library=test_hashes.json --mpl-hash-library=mpl35_ft261.json --mpl-results-path=results --mpl-generate-summary=html,json
100+
pytest --mpl \
101+
--mpl-generate-hash-library=test_hashes.json \
102+
--mpl-hash-library=mpl35_ft261.json \
103+
--mpl-results-path=results \
104+
--mpl-generate-summary=html,json
82105
83106
:summary:`test_html_run_generate_hashes_only`
84107

85108
.. card:: Hybrid mode: hash and image comparison
86109

87110
.. code-block:: bash
88111
89-
pytest --mpl --mpl-hash-library=mpl35_ft261.json --mpl-baseline-path=baseline --mpl-results-path=results --mpl-generate-summary=basic-html,json
112+
pytest --mpl \
113+
--mpl-hash-library=mpl35_ft261.json \
114+
--mpl-baseline-path=baseline \
115+
--mpl-results-path=results \
116+
--mpl-generate-summary=basic-html,json
90117
91118
:summary:`test_basic_html`
92119

0 commit comments

Comments
 (0)