Skip to content

Commit 3d57a07

Browse files
committed
docs: document the report:format setting
1 parent 8e30221 commit 3d57a07

File tree

3 files changed

+20
-0
lines changed

3 files changed

+20
-0
lines changed

CHANGES.rst

+6
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,12 @@ Unreleased
2929

3030
- Fix: clicking a line number in the HTML report now positions more accurately.
3131

32+
- Fix: the ``report:format`` setting was defined as a boolean, but should be a
33+
string. Thanks, `Tanaydin Sirin <pull 1754_>`_. It is also now documented
34+
on the :ref:`configuration page <config_report_format>`.
35+
36+
.. _pull 1754: https://github.com/nedbat/coveragepy/pull/1754
37+
3238

3339
.. scriv-start-here
3440

CONTRIBUTORS.txt

+1
Original file line numberDiff line numberDiff line change
@@ -209,6 +209,7 @@ Steve Leonard
209209
Steve Oswald
210210
Steve Peak
211211
Sviatoslav Sydorenko
212+
Tanaydin Sirin
212213
Teake Nutma
213214
Ted Wexler
214215
Thijs Triemstra

doc/config.rst

+13
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,19 @@ use of the decimal places. A setting of 100 will fail any value under 100,
627627
regardless of the number of decimal places of precision.
628628

629629

630+
.. _config_report_format:
631+
632+
[report] format
633+
...............
634+
635+
(string, default "text") The format to use for the textual report. The default
636+
is "text" which produces a simple textual table. You can use "markdown" to
637+
produce a Markdown table, or "total" to output only the total coverage
638+
percentage.
639+
640+
.. versionadded:: 7.0
641+
642+
630643
.. _config_report_ignore_errors:
631644

632645
[report] ignore_errors

0 commit comments

Comments
 (0)