diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2022-11-05 12:51:13 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2022-11-05 13:02:22 -0400 |
| commit | 01d86775522ed67a246f2b17657e7a119cb6b8a1 (patch) | |
| tree | ddd6cfda0db8bdfb3d6ac88ecc06548b1c46eecc | |
| parent | 5a3e1e85c9e614b792cdaa5fad6f863e998295be (diff) | |
| download | python-coveragepy-git-01d86775522ed67a246f2b17657e7a119cb6b8a1.tar.gz | |
docs: changelog and docs for `coverage report --format=markdown`
| -rw-r--r-- | CHANGES.rst | 7 | ||||
| -rw-r--r-- | CONTRIBUTORS.txt | 1 | ||||
| -rw-r--r-- | doc/cmd.rst | 4 |
3 files changed, 12 insertions, 0 deletions
diff --git a/CHANGES.rst b/CHANGES.rst index 9453f1ae..ce4b4926 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -20,9 +20,16 @@ development at the same time, such as 4.5.x and 5.0. Unreleased ---------- +- Text reporting with ``coverage report`` now has a ``--format=`` option. + The original style (``--format=text``) is the default. Now you can also + use ``--format=markdown`` to get the table in Markdown format, thanks to + Steve Oswald in `pull 1479`_, closing `issue 1418`_. + - Fixed a mis-measurement of a strange use of wildcard alternatives in match/case statements, closing `issue 1421`_. +.. _pull 1479: https://github.com/nedbat/coveragepy/pull/1479 +.. _issue 1418: https://github.com/nedbat/coveragepy/issues/1418 .. _issue 1421: https://github.com/nedbat/coveragepy/issues/1421 diff --git a/CONTRIBUTORS.txt b/CONTRIBUTORS.txt index 4bf9a193..b57c35d5 100644 --- a/CONTRIBUTORS.txt +++ b/CONTRIBUTORS.txt @@ -150,6 +150,7 @@ Stephan Richter Stephen Finucane Steve Dower Steve Leonard +Steve Oswald Steve Peak Sviatoslav Sydorenko S. Y. Lee diff --git a/doc/cmd.rst b/doc/cmd.rst index fd1f7d1a..7b49ec14 100644 --- a/doc/cmd.rst +++ b/doc/cmd.rst @@ -592,6 +592,10 @@ decimal point in coverage percentages, defaulting to none. The ``--sort`` option is the name of a column to sort the report by. +The ``--format`` option controls the style of the table. ``--format=text`` +creates plain text tables as shown above. ``--format=markdown`` creates +Markdown tables. + Other common reporting options are described above in :ref:`cmd_reporting`. These options can also be set in your .coveragerc file. See :ref:`Configuration: [report] <config_report>`. |