docs: document the report:format setting

nedbat · Mar 10, 2024 · 3d57a07 · 3d57a07
1 parent 8e30221
commit 3d57a07
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -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
 

diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt
@@ -209,6 +209,7 @@ Steve Leonard
 Steve Oswald
 Steve Peak
 Sviatoslav Sydorenko
+Tanaydin Sirin
 Teake Nutma
 Ted Wexler
 Thijs Triemstra

diff --git a/doc/config.rst b/doc/config.rst
@@ -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