diff --git a/doc/en/assert.rst b/doc/en/assert.rst index e6a23bcf3..c0314f344 100644 --- a/doc/en/assert.rst +++ b/doc/en/assert.rst @@ -1,5 +1,5 @@ -The writing and reporting of assertions in tests +How to write and report assertions in tests ================================================== .. _`assertfeedback`: diff --git a/doc/en/bash-completion.rst b/doc/en/bash-completion.rst index eaa078814..245dfd6d9 100644 --- a/doc/en/bash-completion.rst +++ b/doc/en/bash-completion.rst @@ -1,8 +1,8 @@ .. _bash_completion: -Setting up bash completion -========================== +How to set up bash completion +============================= When using bash as your shell, ``pytest`` can use argcomplete (https://argcomplete.readthedocs.io/) for auto-completion. diff --git a/doc/en/capture.rst b/doc/en/capture.rst index caaebdf81..ea0063853 100644 --- a/doc/en/capture.rst +++ b/doc/en/capture.rst @@ -1,7 +1,7 @@ .. _`captures`: -Capturing of the stdout/stderr output +How to capture stdout/stderr output ========================================================= Default stdout/stderr/stdin capturing behaviour diff --git a/doc/en/existingtestsuite.rst b/doc/en/existingtestsuite.rst index 1e3e192bf..9909e7d11 100644 --- a/doc/en/existingtestsuite.rst +++ b/doc/en/existingtestsuite.rst @@ -1,7 +1,7 @@ .. _existingtestsuite: -Using pytest with an existing test suite -=========================================== +How to use pytest with an existing test suite +============================================== Pytest can be used with most existing test suites, but its behavior differs from other test runners such as :ref:`nose ` or diff --git a/doc/en/mark.rst b/doc/en/mark.rst index 7370342a9..33f9d18bf 100644 --- a/doc/en/mark.rst +++ b/doc/en/mark.rst @@ -1,7 +1,7 @@ .. _mark: -Marking test functions with attributes -====================================== +How to mark test functions with attributes +=========================================== By using the ``pytest.mark`` helper you can easily set metadata on your test functions. You can find the full list of builtin markers diff --git a/doc/en/monkeypatch.rst b/doc/en/monkeypatch.rst index 4964ee548..d3c7689e4 100644 --- a/doc/en/monkeypatch.rst +++ b/doc/en/monkeypatch.rst @@ -1,5 +1,5 @@ -Monkeypatching/mocking modules and environments +How to monkeypatch/mock modules and environments ================================================================ .. currentmodule:: _pytest.monkeypatch diff --git a/doc/en/nose.rst b/doc/en/nose.rst index e16d76469..486b3db75 100644 --- a/doc/en/nose.rst +++ b/doc/en/nose.rst @@ -1,6 +1,6 @@ .. _`noseintegration`: -Running tests written for nose +How to run tests written for nose ======================================= ``pytest`` has basic support for running tests written for nose_. diff --git a/doc/en/parametrize.rst b/doc/en/parametrize.rst index 9e531ddd4..7f5f6ea0c 100644 --- a/doc/en/parametrize.rst +++ b/doc/en/parametrize.rst @@ -6,7 +6,7 @@ .. _`parametrize-basics`: -Parametrizing fixtures and test functions +How to parametrize fixtures and test functions ========================================================================== pytest enables test parametrization at several levels: diff --git a/doc/en/plugins.rst b/doc/en/plugins.rst index 8090e7d18..ade51abad 100644 --- a/doc/en/plugins.rst +++ b/doc/en/plugins.rst @@ -2,8 +2,8 @@ .. _`extplugins`: .. _`using plugins`: -Installing and Using plugins -============================ +How to install and use plugins +=============================== This section talks about installing and using third party plugins. For writing your own plugins, please refer to :ref:`writing-plugins`. diff --git a/doc/en/skipping.rst b/doc/en/skipping.rst index 610d3d43b..66db74a1f 100644 --- a/doc/en/skipping.rst +++ b/doc/en/skipping.rst @@ -2,8 +2,8 @@ .. _skipping: -Skip and xfail: dealing with tests that cannot succeed -====================================================== +How to use skip and xfail to deal with tests that cannot succeed +================================================================= You can mark test functions that cannot be run on certain platforms or that you expect to fail so pytest can deal with them accordingly and diff --git a/doc/en/tmpdir.rst b/doc/en/tmpdir.rst index adcba02cb..379c6d84c 100644 --- a/doc/en/tmpdir.rst +++ b/doc/en/tmpdir.rst @@ -2,8 +2,8 @@ .. _`tmpdir handling`: .. _tmpdir: -Temporary directories and files -================================================ +How to use temporary directories and files in tests +=================================================== The ``tmp_path`` fixture ------------------------ diff --git a/doc/en/usage.rst b/doc/en/usage.rst index 0a26182d4..32af9fbeb 100644 --- a/doc/en/usage.rst +++ b/doc/en/usage.rst @@ -1,7 +1,7 @@ .. _usage: -Usage and Invocations +How to invoke pytest ==========================================