summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Cutler <paul.r.cutler@gmail.com>2018-10-03 10:06:48 -0500
committerPaul Cutler <paul.r.cutler@gmail.com>2018-10-03 10:06:48 -0500
commitf9c3ff6db52f107f298852b92ecc945fbc26229c (patch)
tree9011d9b20a045dda4b565b17a4f1dc9379791779
parentd363b4ef2ac1463df99993841749c536aacbd07f (diff)
downloadpyramid-f9c3ff6db52f107f298852b92ecc945fbc26229c.tar.gz
pyramid-f9c3ff6db52f107f298852b92ecc945fbc26229c.tar.bz2
pyramid-f9c3ff6db52f107f298852b92ecc945fbc26229c.zip
Change references to "py.test" in narrative documentation
Change reference of "py.test" to "pytest" per pytest 3.0 release in the project and testing pages of narrative documentation
-rw-r--r--docs/narr/project.rst24
-rw-r--r--docs/narr/testing.rst4
2 files changed, 14 insertions, 14 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index fb5a241db..a15138207 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -239,26 +239,26 @@ On Windows:
%VENV%\Scripts\pip install -e ".[testing]"
Once the testing requirements are installed, then you can run the tests using
-the ``py.test`` command that was just installed in the ``bin`` directory of
+the ``pytest`` command that was just installed in the ``bin`` directory of
your virtual environment.
On Unix:
.. code-block:: bash
- $VENV/bin/py.test -q
+ $VENV/bin/pytest -q
On Windows:
.. code-block:: doscon
- %VENV%\Scripts\py.test -q
+ %VENV%\Scripts\pytest -q
Here's sample output from a test run on Unix:
.. code-block:: bash
- $VENV/bin/py.test -q
+ $VENV/bin/pytest -q
..
2 passed in 0.47 seconds
@@ -266,28 +266,28 @@ The tests themselves are found in the ``tests.py`` module in your ``cookiecutter
.. note::
- The ``-q`` option is passed to the ``py.test`` command to limit the output
+ The ``-q`` option is passed to the ``pytest`` command to limit the output
to a stream of dots. If you don't pass ``-q``, you'll see verbose test
result output (which normally isn't very useful).
Alternatively, if you'd like to see test coverage, pass the ``--cov`` option
-to ``py.test``:
+to ``pytest``:
.. code-block:: bash
- $VENV/bin/py.test --cov -q
+ $VENV/bin/pytest --cov -q
-Cookiecutters include configuration defaults for ``py.test`` and test coverage.
+Cookiecutters include configuration defaults for ``pytest`` 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
+ $VENV/bin/pytest --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.
+.. seealso:: See pytest's documentation for :ref:`pytest:usage` or invoke
+ ``pytest -h`` to see its full set of options.
.. index::
@@ -1042,7 +1042,7 @@ The ``tests.py`` module includes tests for your application.
:linenos:
This sample ``tests.py`` file has one unit test and one functional test defined
-within it. These tests are executed when you run ``py.test -q``. You may add
+within it. These tests are executed when you run ``pytest -q``. You may add
more tests here as you build your application. You are not required to write
tests to use :app:`Pyramid`. This file is simply provided for convenience and
example.
diff --git a/docs/narr/testing.rst b/docs/narr/testing.rst
index ad4ba2186..8048ca62c 100644
--- a/docs/narr/testing.rst
+++ b/docs/narr/testing.rst
@@ -275,7 +275,7 @@ without needing to invoke the actual application configuration implied by its
In the above example, we create a ``MyTest`` test case that inherits from
:class:`unittest.TestCase`. If it's in our :app:`Pyramid` application, it will
-be found when ``py.test`` is run. It has two test methods.
+be found when ``pytest`` is run. It has two test methods.
The first test method, ``test_view_fn_forbidden`` tests the ``view_fn`` when
the authentication policy forbids the current user the ``edit`` permission. Its
@@ -365,7 +365,7 @@ Functional tests test your literal application.
In Pyramid, functional tests are typically written using the :term:`WebTest`
package, which provides APIs for invoking HTTP(S) requests to your application.
-We also like ``py.test`` and ``pytest-cov`` to provide simple testing and
+We also like ``pytest`` and ``pytest-cov`` to provide simple testing and
coverage reports.
Regardless of which testing :term:`package` you use, be sure to add a