Skip to content

Commit 01d8677

Browse files
committed
docs: changelog and docs for coverage report --format=markdown
1 parent 5a3e1e8 commit 01d8677

File tree

3 files changed

+12
-0
lines changed

3 files changed

+12
-0
lines changed

CHANGES.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,16 @@ development at the same time, such as 4.5.x and 5.0.
2020
Unreleased
2121
----------
2222

23+
- Text reporting with ``coverage report`` now has a ``--format=`` option.
24+
The original style (``--format=text``) is the default. Now you can also
25+
use ``--format=markdown`` to get the table in Markdown format, thanks to
26+
Steve Oswald in `pull 1479`_, closing `issue 1418`_.
27+
2328
- Fixed a mis-measurement of a strange use of wildcard alternatives in
2429
match/case statements, closing `issue 1421`_.
2530

31+
.. _pull 1479: https://github.com/nedbat/coveragepy/pull/1479
32+
.. _issue 1418: https://github.com/nedbat/coveragepy/issues/1418
2633
.. _issue 1421: https://github.com/nedbat/coveragepy/issues/1421
2734

2835

CONTRIBUTORS.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,7 @@ Stephan Richter
150150
Stephen Finucane
151151
Steve Dower
152152
Steve Leonard
153+
Steve Oswald
153154
Steve Peak
154155
Sviatoslav Sydorenko
155156
S. Y. Lee

doc/cmd.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -592,6 +592,10 @@ decimal point in coverage percentages, defaulting to none.
592592

593593
The ``--sort`` option is the name of a column to sort the report by.
594594

595+
The ``--format`` option controls the style of the table. ``--format=text``
596+
creates plain text tables as shown above. ``--format=markdown`` creates
597+
Markdown tables.
598+
595599
Other common reporting options are described above in :ref:`cmd_reporting`.
596600
These options can also be set in your .coveragerc file. See
597601
:ref:`Configuration: [report] <config_report>`.

0 commit comments

Comments
 (0)