diff options
| author | Ned Batchelder <ned@nedbatchelder.com> | 2021-05-29 12:54:00 -0400 |
|---|---|---|
| committer | Ned Batchelder <ned@nedbatchelder.com> | 2021-05-29 12:54:00 -0400 |
| commit | 22fe2eb167a18dda8fd3e14cbf9166a1c7331fb9 (patch) | |
| tree | a51e1dc67ccc1106078260f6698cf4743cd0c4c2 /doc/index.rst | |
| parent | c41e8840131497db54edcaa43931c05bfc973196 (diff) | |
| download | python-coveragepy-git-22fe2eb167a18dda8fd3e14cbf9166a1c7331fb9.tar.gz | |
doc: mention dynamic contexts in more places
Diffstat (limited to 'doc/index.rst')
| -rw-r--r-- | doc/index.rst | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/doc/index.rst b/doc/index.rst index a06ad1b6..13c25ca1 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -137,6 +137,24 @@ Getting started is easy: .. _report like this one: https://nedbatchelder.com/files/sample_coverage_html_beta/index.html +Capabilities +------------ + +Coverage.py can do a number of things: + +- By default it will measure line (statement) coverage. + +- It can also measure :ref:`branch coverage <branch>`. + +- It can tell you :ref:`what tests ran which lines <dynamic_contexts>`. + +- It can produce reports in a number of formats: :ref:`text <cmd_report>`, + :ref:`HTML <cmd_html>`, :ref:`XML <cmd_xml>`, and :ref:`JSON <cmd_json>`. + +- For advanced uses, there's an :ref:`API <api>`, and the result data is + available in a :ref:`SQLite database <dbschema>`. + + Using coverage.py ----------------- |