Skip to content

Commit 1adda03

Browse files
committed
docs: a little more in the quick start about what will be measured. #1707
1 parent 6a9766e commit 1adda03

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

doc/index.rst

+8-1
Original file line numberDiff line numberDiff line change
@@ -111,9 +111,14 @@ Getting started is easy:
111111

112112
$ coverage run -m nose arg1 arg2
113113

114+
Coverage doesn't distinguish between tests and the code being tested.
115+
We `recommend that you include your tests in coverage measurement <include
116+
tests_>`_.
117+
114118
To limit coverage measurement to code in the current directory, and also
115119
find files that weren't executed at all, add the ``--source=.`` argument to
116-
your coverage command line.
120+
your coverage command line. You can also :ref:`specify source files to
121+
measure <source>` or :ref:`exclude code from measurement <excluding>`.
117122

118123
#. Use ``coverage report`` to report on the results::
119124

@@ -144,6 +149,8 @@ Getting started is easy:
144149
.. _report like this: https://nedbatchelder.com/files/sample_coverage_html/index.html
145150
.. _report like this one: https://nedbatchelder.com/files/sample_coverage_html_beta/index.html
146151
.. _nose state: https://github.com/nose-devs/nose/commit/0f40fa995384afad77e191636c89eb7d5b8870ca
152+
.. _include tests: https://nedbatchelder.com/blog/202008/you_should_include_your_tests_in_coverage.html
153+
147154

148155

149156
Capabilities

0 commit comments

Comments
 (0)