summaryrefslogtreecommitdiff
path: root/docs/tutorials
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2018-10-04 17:09:06 -0700
committerGitHub <noreply@github.com>2018-10-04 17:09:06 -0700
commitd2c9dd9d0ae534a085c7adbff869de357714812b (patch)
treec4a5c1925c06968952a5d961926f980dd26e27d8 /docs/tutorials
parent052cb72b63b9f5a36f45a4135d1e1c05c10004dd (diff)
parent9c39f657e9edbb59ef83a375500596f500c70a44 (diff)
downloadpyramid-d2c9dd9d0ae534a085c7adbff869de357714812b.tar.gz
pyramid-d2c9dd9d0ae534a085c7adbff869de357714812b.tar.bz2
pyramid-d2c9dd9d0ae534a085c7adbff869de357714812b.zip
Merge pull request #3367 from prcutler/update-pytest-docs
Change all references of "py.test" to "pytest" in Pyramid documentation
Diffstat (limited to 'docs/tutorials')
-rw-r--r--docs/tutorials/wiki/installation.rst30
-rw-r--r--docs/tutorials/wiki/tests.rst8
-rw-r--r--docs/tutorials/wiki2/installation.rst30
-rw-r--r--docs/tutorials/wiki2/tests.rst4
4 files changed, 36 insertions, 36 deletions
diff --git a/docs/tutorials/wiki/installation.rst b/docs/tutorials/wiki/installation.rst
index 7f914267f..639aa0881 100644
--- a/docs/tutorials/wiki/installation.rst
+++ b/docs/tutorials/wiki/installation.rst
@@ -195,22 +195,22 @@ Run the tests
After you've installed the project in development mode as well as the testing
requirements, you may run the tests for the project. The following commands
-provide options to py.test that specify the module for which its tests shall be
-run, and to run py.test in quiet mode.
+provide options to ``pytest`` that specify the module for which its tests shall be
+run, and to run ``pytest`` in quiet mode.
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
For a successful test run, you should see output that ends like this:
@@ -223,8 +223,8 @@ For a successful test run, you should see output that ends like this:
Expose test coverage information
--------------------------------
-You can run the ``py.test`` command to see test coverage information. This
-runs the tests in the same way that ``py.test`` does, but provides additional
+You can run the ``pytest`` command to see test coverage information. This
+runs the tests in the same way that ``pytest`` does, but provides additional
:term:`coverage` information, exposing which lines of your project are covered by the
tests.
@@ -236,14 +236,14 @@ On Unix
.. code-block:: bash
- $VENV/bin/py.test --cov --cov-report=term-missing
+ $VENV/bin/pytest --cov --cov-report=term-missing
On Windows
^^^^^^^^^^
.. code-block:: doscon
- %VENV%\Scripts\py.test --cov --cov-report=term-missing
+ %VENV%\Scripts\pytest --cov --cov-report=term-missing
If successful, you will see output something like this:
@@ -275,7 +275,7 @@ Our package doesn't quite have 100% test coverage.
Test and coverage cookiecutter defaults
---------------------------------------
-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.
@@ -285,22 +285,22 @@ On Unix
.. code-block:: bash
- $VENV/bin/py.test --cov=tutorial tutorial/tests.py -q
+ $VENV/bin/pytest --cov=tutorial tutorial/tests.py -q
On Windows
^^^^^^^^^^
.. code-block:: doscon
- %VENV%\Scripts\py.test --cov=tutorial tutorial\tests.py -q
+ %VENV%\Scripts\pytest --cov=tutorial tutorial\tests.py -q
-py.test follows :ref:`conventions for Python test discovery
+``pytest`` follows :ref:`conventions for Python test discovery
<pytest:test discovery>`, and the configuration defaults from the cookiecutter
-tell ``py.test`` where to find the module on which we want to run tests and
+tell ``pytest`` where to find the module on which we want to run tests and
coverage.
-.. 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.
.. _wiki-start-the-application:
diff --git a/docs/tutorials/wiki/tests.rst b/docs/tutorials/wiki/tests.rst
index c3a1ca79a..6c7f24645 100644
--- a/docs/tutorials/wiki/tests.rst
+++ b/docs/tutorials/wiki/tests.rst
@@ -51,22 +51,22 @@ follows:
Running the tests
=================
-We can run these tests by using ``py.test`` similarly to how we did in
+We can run these tests by using ``pytest`` similarly to how we did in
:ref:`running_tests`. Courtesy of the cookiecutter, our testing dependencies have
-already been satisfied and ``py.test`` and coverage have already been
+already been satisfied and ``pytest`` and coverage have already been
configured, so we can jump right to running tests.
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
The expected result should look like the following:
diff --git a/docs/tutorials/wiki2/installation.rst b/docs/tutorials/wiki2/installation.rst
index 5f2c6d44e..b2f1dde4a 100644
--- a/docs/tutorials/wiki2/installation.rst
+++ b/docs/tutorials/wiki2/installation.rst
@@ -342,22 +342,22 @@ Run the tests
After you've installed the project in development mode as well as the testing
requirements, you may run the tests for the project. The following commands
-provide options to py.test that specify the module for which its tests shall be
-run, and to run py.test in quiet mode.
+provide options to ``pytest`` that specify the module for which its tests shall be
+run, and to run ``pytest`` in quiet mode.
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
For a successful test run, you should see output that ends like this:
@@ -370,8 +370,8 @@ For a successful test run, you should see output that ends like this:
Expose test coverage information
--------------------------------
-You can run the ``py.test`` command to see test coverage information. This
-runs the tests in the same way that ``py.test`` does, but provides additional
+You can run the ``pytest`` command to see test coverage information. This
+runs the tests in the same way that ``pytest`` does, but provides additional
:term:`coverage` information, exposing which lines of your project are covered by the
tests.
@@ -383,14 +383,14 @@ On Unix
.. code-block:: bash
- $VENV/bin/py.test --cov --cov-report=term-missing
+ $VENV/bin/pytest --cov --cov-report=term-missing
On Windows
^^^^^^^^^^
.. code-block:: doscon
- c:\tutorial> %VENV%\Scripts\py.test --cov --cov-report=term-missing
+ c:\tutorial> %VENV%\Scripts\pytest --cov --cov-report=term-missing
If successful, you will see output something like this:
@@ -429,7 +429,7 @@ Our package doesn't quite have 100% test coverage.
Test and coverage cookiecutter defaults
---------------------------------------
-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.
@@ -439,22 +439,22 @@ On Unix
.. code-block:: bash
- $VENV/bin/py.test --cov=tutorial tutorial/tests.py -q
+ $VENV/bin/pytest --cov=tutorial tutorial/tests.py -q
On Windows
^^^^^^^^^^
.. code-block:: doscon
- %VENV%\Scripts\py.test --cov=tutorial tutorial\tests.py -q
+ %VENV%\Scripts\pytest --cov=tutorial tutorial\tests.py -q
-py.test follows :ref:`conventions for Python test discovery
+pytest follows :ref:`conventions for Python test discovery
<pytest:test discovery>`, and the configuration defaults from the cookiecutter
-tell ``py.test`` where to find the module on which we want to run tests and
+tell ``pytest`` where to find the module on which we want to run tests and
coverage.
-.. 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.
.. _wiki2-start-the-application:
diff --git a/docs/tutorials/wiki2/tests.rst b/docs/tutorials/wiki2/tests.rst
index f3f89fe9c..fb33fc629 100644
--- a/docs/tutorials/wiki2/tests.rst
+++ b/docs/tutorials/wiki2/tests.rst
@@ -99,14 +99,14 @@ On Unix:
.. code-block:: bash
rm tutorial.sqlite
- $VENV/bin/py.test -q
+ $VENV/bin/pytest -q
On Windows:
.. code-block:: doscon
del tutorial.sqlite
- %VENV%\Scripts\py.test -q
+ %VENV%\Scripts\pytest -q
The expected result should look like the following: