Skip to content

Commit 40e9e8e

Browse files
marcosbogerionelmc
authored andcommitted
Add docs and update AUTHORS.rst
1 parent f5ca33a commit 40e9e8e

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

AUTHORS.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,3 +63,4 @@ Authors
6363
* Christian Clauss - https://github.com/cclauss
6464
* Dawn James - https://github.com/dawngerpony
6565
* Tsvika Shapira - https://github.com/tsvikas
66+
* Marcos Boger - https://github.com/marcosboger

docs/config.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,9 +64,9 @@ The complete list of command line options is:
6464

6565
--cov=PATH Measure coverage for filesystem path. (multi-allowed)
6666
--cov-report=type Type of report to generate: term, term-missing,
67-
annotate, html, xml, json, lcov (multi-allowed). term, term-
67+
annotate, html, xml, json, markdown, markdown-append, lcov (multi-allowed). term, term-
6868
missing may be followed by ":skip-covered". annotate,
69-
html, xml, json and lcov may be followed by ":DEST" where DEST
69+
html, xml, json, markdown, markdown-append and lcov may be followed by ":DEST" where DEST
7070
specifies the output location. Use --cov-report= to
7171
not generate any output.
7272
--cov-config=path Config file for coverage. Default: .coveragerc

docs/reporting.rst

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Reporting
33

44
It is possible to generate any combination of the reports for a single test run.
55

6-
The available reports are terminal (with or without missing line numbers shown), HTML, XML, JSON, LCOV and
6+
The available reports are terminal (with or without missing line numbers shown), HTML, XML, JSON, MARKDOWN (either in 'write' or 'append' mode to file), LCOV and
77
annotated source code.
88

99
The terminal report without line numbers (default)::
@@ -49,22 +49,26 @@ The terminal report with skip covered::
4949

5050
You can use ``skip-covered`` with ``term-missing`` as well. e.g. ``--cov-report term-missing:skip-covered``
5151

52-
These four report options output to files without showing anything on the terminal::
52+
These seven report options output to files without showing anything on the terminal::
5353

5454
pytest --cov-report html
5555
--cov-report xml
5656
--cov-report json
57+
--cov-report markdown
58+
--cov-report markdown-append
5759
--cov-report lcov
5860
--cov-report annotate
5961
--cov=myproj tests/
6062

61-
The output location for each of these reports can be specified. The output location for the XML, JSON and LCOV
63+
The output location for each of these reports can be specified. The output location for the XML, JSON, MARKDOWN and LCOV
6264
report is a file. Where as the output location for the HTML and annotated source code reports are
6365
directories::
6466

6567
pytest --cov-report html:cov_html
6668
--cov-report xml:cov.xml
6769
--cov-report json:cov.json
70+
--cov-report markdown:cov.md
71+
--cov-report markdown-append:cov.md
6872
--cov-report lcov:cov.info
6973
--cov-report annotate:cov_annotate
7074
--cov=myproj tests/

0 commit comments

Comments
 (0)