summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2023-01-13 15:15:46 -0500
committerNed Batchelder <ned@nedbatchelder.com>2023-01-13 15:42:33 -0500
commit0667611a82eac81818f40173acfca22a35fc1d9d (patch)
treeea7a6364479b0994e7284f150e94cc6c6d47737c
parent24cf494264842e94bd33d73850408219d4d17f10 (diff)
downloadpython-coveragepy-git-0667611a82eac81818f40173acfca22a35fc1d9d.tar.gz
docs: tweak quickstart to make basic step clearer
-rw-r--r--doc/index.rst14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/index.rst b/doc/index.rst
index 47fe4f1f..309cba59 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -61,11 +61,17 @@ Getting started is easy:
For more details, see :ref:`install`.
#. Use ``coverage run`` to run your test suite and gather data. However you
- normally run your test suite, you can run your test runner under coverage.
- If your test runner command starts with "python", just replace the initial
- "python" with "coverage run".
+ normally run your test suite, you can use your test runner under coverage.
- Instructions for specific test runners:
+ .. tip::
+ If your test runner command starts with "python", just replace the initial
+ "python" with "coverage run".
+
+ ``python something.py`` becomes ``coverage run something.py``
+
+ ``python -m amodule`` becomes ``coverage run -m amodule``
+
+ Other instructions for specific test runners:
- **pytest**