From f9c3ff6db52f107f298852b92ecc945fbc26229c Mon Sep 17 00:00:00 2001 From: Paul Cutler Date: Wed, 3 Oct 2018 10:06:48 -0500 Subject: 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 --- docs/narr/project.rst | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) (limited to 'docs/narr/project.rst') 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. -- cgit v1.2.3 From 9c39f657e9edbb59ef83a375500596f500c70a44 Mon Sep 17 00:00:00 2001 From: Paul Cutler Date: Thu, 4 Oct 2018 11:02:14 -0500 Subject: Update Pyramid documentation pytest references with feedback Update the pull request to update all Pyramid documentation to replace instances of "py.test" with "pytest" to include missing backticks where needed. --- docs/narr/project.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/narr/project.rst') diff --git a/docs/narr/project.rst b/docs/narr/project.rst index a15138207..5efc07e09 100644 --- a/docs/narr/project.rst +++ b/docs/narr/project.rst @@ -286,7 +286,7 @@ path to the module on which we want to run tests and coverage. $VENV/bin/pytest --cov=myproject myproject/tests.py -q -.. seealso:: See pytest's documentation for :ref:`pytest:usage` or invoke +.. seealso:: See ``pytest``'s documentation for :ref:`pytest:usage` or invoke ``pytest -h`` to see its full set of options. -- cgit v1.2.3