summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-05-07 00:54:55 -0700
committerSteve Piercy <web@stevepiercy.com>2016-05-07 00:54:55 -0700
commite09369f02f61f2443f393bcd29fa84e970268b53 (patch)
tree3979a79a36fef5e736b67a54d04c07b444be4d91 /docs
parenta692f4c9bd4cb0357447558b758beecb7f966817 (diff)
downloadpyramid-e09369f02f61f2443f393bcd29fa84e970268b53.tar.gz
pyramid-e09369f02f61f2443f393bcd29fa84e970268b53.tar.bz2
pyramid-e09369f02f61f2443f393bcd29fa84e970268b53.zip
wordsmith py.test and coverage configuration
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/project.rst20
1 files changed, 14 insertions, 6 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 8849e9ee7..a25394151 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -227,11 +227,7 @@ Here's sample output from a test run on UNIX:
The tests themselves are found in the ``tests.py`` module in your ``pcreate``
generated project. Within a project generated by the ``starter`` scaffold,
-only two sample tests exist. Previous command is identical to:
-
-.. code-block:: bash
-
- $ $VENV/bin/py.test myproject/tests.py -q
+only two sample tests exist.
.. note::
@@ -244,7 +240,19 @@ to ``py.test``:
.. code-block:: bash
- $ $VENV/bin/py.test -q --cov
+ $ $VENV/bin/py.test --cov -q
+
+Scaffolds include configuration defaults for ``py.test`` and test coverage.
+These configuration files are ``pytest.ini`` and ``.coveragerc``, located at
+the root of your package. Without these defaults, we would need to specify the
+path to the module on which we want to run tests and coverage.
+
+.. code-block:: bash
+
+ $ $VENV/bin/py.test --cov=myproject myproject/tests.py -q
+
+.. seealso:: See py.test's documentation for :ref:`pytest:usage` or invoke
+ ``py.test -h`` to see its full set of options.
.. index::