summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2021-08-06 06:26:09 -0400
committerNed Batchelder <ned@nedbatchelder.com>2021-08-06 06:26:09 -0400
commita17f6eea453197dc6c013410c4df9cf9a28fec42 (patch)
treef95bd2c469c9bed49b247d6c61c3521be5064c67 /doc
parent6224688e4fe038c6ecaa851489c688bd6f4eb457 (diff)
downloadpython-coveragepy-git-a17f6eea453197dc6c013410c4df9cf9a28fec42.tar.gz
docs: skip_covered and skip_empty were never documented
Diffstat (limited to 'doc')
-rw-r--r--doc/config.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/config.rst b/doc/config.rst
index db85ba33..8d0fc7e2 100644
--- a/doc/config.rst
+++ b/doc/config.rst
@@ -327,6 +327,16 @@ setting also affects the interpretation of the ``fail_under`` setting.
``show_missing`` (boolean, default False): when running a summary report, show
missing lines. See :ref:`cmd_report` for more information.
+.. _config_report_skip_covered:
+
+``skip_covered`` (boolean, default False): don't report files that are 100%
+covered. This helps you focus on files that need attention.
+
+.. _config_report_skip_empty:
+
+``skip_empty`` (boolean, default False): don't report files that have no
+executable code (such as ``__init__.py`` files).
+
.. _config_report_sort:
``sort`` (string, default "Name"): Sort the text report by the named column.