docs: document the report:format setting · nedbat/coveragepy@3d57a07 (original) (raw)

3 files changed

lines changed

Original file line number Diff line number Diff line change
@@ -29,6 +29,12 @@ Unreleased
29 29
30 30 - Fix: clicking a line number in the HTML report now positions more accurately.
31 31
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 +
32 38
33 39 .. scriv-start-here
34 40
Original file line number Diff line number Diff line change
@@ -209,6 +209,7 @@ Steve Leonard
209 209 Steve Oswald
210 210 Steve Peak
211 211 Sviatoslav Sydorenko
212 +Tanaydin Sirin
212 213 Teake Nutma
213 214 Ted Wexler
214 215 Thijs Triemstra
Original file line number Diff line number Diff line change
@@ -627,6 +627,19 @@ use of the decimal places. A setting of 100 will fail any value under 100,
627 627 regardless of the number of decimal places of precision.
628 628
629 629
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 +
630 643 .. _config_report_ignore_errors:
631 644
632 645 [report] ignore_errors