Skip to content

Commit

Permalink
docs: document the report:format setting
Browse files Browse the repository at this point in the history
  • Loading branch information
nedbat committed Mar 10, 2024
1 parent 8e30221 commit 3d57a07
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ Unreleased

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

- Fix: the ``report:format`` setting was defined as a boolean, but should be a
string. Thanks, `Tanaydin Sirin <pull 1754_>`_. It is also now documented
on the :ref:`configuration page <config_report_format>`.

.. _pull 1754: https://github.com/nedbat/coveragepy/pull/1754


.. scriv-start-here
Expand Down
1 change: 1 addition & 0 deletions CONTRIBUTORS.txt
Original file line number Diff line number Diff line change
Expand Up @@ -209,6 +209,7 @@ Steve Leonard
Steve Oswald
Steve Peak
Sviatoslav Sydorenko
Tanaydin Sirin
Teake Nutma
Ted Wexler
Thijs Triemstra
Expand Down
13 changes: 13 additions & 0 deletions doc/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -627,6 +627,19 @@ use of the decimal places. A setting of 100 will fail any value under 100,
regardless of the number of decimal places of precision.


.. _config_report_format:

[report] format
...............

(string, default "text") The format to use for the textual report. The default
is "text" which produces a simple textual table. You can use "markdown" to
produce a Markdown table, or "total" to output only the total coverage
percentage.

.. versionadded:: 7.0


.. _config_report_ignore_errors:

[report] ignore_errors
Expand Down

0 comments on commit 3d57a07

Please sign in to comment.