Commits

Dinu Gherman committed 7d983a8

Capitalised start of headlines, added -ing to a few headlines.

  • Participants
  • Parent commits 6fa4598

Comments (0)

Files changed (22)

 
 .. _`assert with the assert statement`:
 
-assert with the ``assert`` statement
+Asserting with the ``assert`` statement
 ---------------------------------------------------------
 
 ``py.test`` allows you to use the standard python ``assert`` for verifying
 
 See :ref:`assert-details` for more information on assertion introspection.
 
-assertions about expected exceptions
+Assertions about expected exceptions
 ------------------------------------------
 
 In order to write assertions about raised exceptions, you can use
 
 .. _`pytest helpers`:
 
-pytest builtin helpers
+Pytest builtin helpers
 ================================================
 
 builtin pytest.* functions and helping objects
 .. automodule:: pytest
     :members:
 
-builtin function arguments
+Builtin function arguments
 -----------------------------------------------------
 
 You can ask for available builtin or project-custom

doc/customize.txt

-basic test configuration
+Basic test configuration
 ===================================
 
 Command line options and configuration file settings
 
 From now on, running ``py.test`` will add the specified options.
 
-builtin configuration file options
+Builtin configuration file options
 ----------------------------------------------
 
 .. confval:: minversion
 
-doctest integration for modules and test files
+Doctest integration for modules and test files
 =========================================================
 
 By default all files matching the ``test*.txt`` pattern will

doc/example/mysetup.txt

 
 .. _mysetup:
 
-mysetup pattern: application specific test fixtures
+Mysetup pattern: application specific test fixtures
 ==========================================================
 
 Here is a basic useful step-by-step example for managing and interacting
 configuring application objects and allow test modules and test
 functions to stay ignorant of involved details.
 
-step1: implementing the test/app-specific ``mysetup`` pattern
--------------------------------------------------------------
+Step 1: Implementing the test/app-specific ``mysetup`` pattern
+--------------------------------------------------------------
 
 Let's write a simple test function using a ``mysetup`` funcarg::
 
 .. _here: http://uncyclopedia.wikia.com/wiki/The_Hitchhiker's_Guide_to_the_Galaxy
 .. _`tut-cmdlineoption`:
 
-step 2: checking a command line option and skipping tests
+Step 2: Checking a command line option and skipping tests
 -----------------------------------------------------------
 
 To add a command line option we update the ``conftest.py`` of

doc/example/nonpython.txt

 
 .. _`yaml plugin`:
 
-a basic example for specifying tests in Yaml files
+A basic example for specifying tests in Yaml files
 --------------------------------------------------------------
 
 .. _`pytest-yamlwsgi`: http://bitbucket.org/aafshar/pytest-yamlwsgi/src/tip/pytest_yamlwsgi.py

doc/example/parametrize.txt

 
 .. _paramexamples:
 
-parametrizing tests
+Parametrizing tests
 =================================================
 
 py.test allows to easily implement your own custom
 parametrization scheme for tests.  Here we provide
 some examples for inspiration and re-use.
 
-generating parameters combinations, depending on command line
+Generating parameters combinations, depending on command line
 ----------------------------------------------------------------------------
 
 .. regendoc:wipe
     test_parametrize2.py:23: Failed
     2 failed, 2 passed in 0.02 seconds
 
-checking serialization between Python interpreters
+Checking serialization between Python interpreters
 --------------------------------------------------------------
 
 Here is a stripped down real-life example of using parametrized

doc/example/pythoncollection.txt

 Changing standard (Python) test discovery
 ===============================================
 
-changing directory recursion
+Changing directory recursion
 -----------------------------------------------------
 
 You can set the :confval:`norecursedirs` option in an ini-file, for example your ``setup.cfg`` in the project root directory::
 
 .. _`change naming conventions`:
 
-change naming conventions
+Changing naming conventions
 -----------------------------------------------------
 
 You can configure different naming conventions by setting
     
     =============================  in 0.01 seconds =============================
 
-interpret cmdline arguments as Python packages
+Interpreting cmdline arguments as Python packages
 -----------------------------------------------------
 
 You can use the ``--pyargs`` option to make py.test try
 if NAME exists as an importable package/module and otherwise
 treat it as a filesystem path.
 
-finding out what is collected
+Finding out what is collected
 -----------------------------------------------
 
 You can always peek at the collection tree without running tests like this::

doc/example/simple.txt

 
 .. highlightlang:: python
 
-basic patterns and examples
+Basic patterns and examples
 ==========================================================
 
-pass different values to a test function, depending on command line options
+Pass different values to a test function, depending on command line options
 ----------------------------------------------------------------------------
 
 .. regendoc:wipe
 on real-life examples.
 
 
-dynamically adding command line options
+Dynamically adding command line options
 --------------------------------------------------------------
 
 .. regendoc:wipe
 
 .. _`excontrolskip`:
 
-control skipping of tests according to command line option
+Control skipping of tests according to command line option
 --------------------------------------------------------------
 
 .. regendoc:wipe
     
     ========================= 2 passed in 0.01 seconds =========================
 
-writing well integrated assertion helpers
+Writing well integrated assertion helpers
 --------------------------------------------------
 
 .. regendoc:wipe
 .. _`py/__init__.py`: http://bitbucket.org/hpk42/py-trunk/src/trunk/py/__init__.py
 
 
-function arguments, parametrized tests and setup
+Function arguments, parametrized tests and setup
 -------------------------------------------------------
 
 .. _funcargs: test/funcargs.html

doc/getting-started.txt

 
     py.test --funcargs   # shows builtin and custom function arguments
 
-where to go next
+Where to go next
 -------------------------------------
 
 Here are a few suggestions where to go next:
 
 .. _mark:
 
-mark test functions with attributes
+Marking test functions with attributes
 =================================================================
 
 .. currentmodule:: _pytest.mark

doc/monkeypatch.txt

 
-monkeypatching/mocking modules and environments
+Monkeypatching/mocking modules and environments
 ================================================================
 
 .. currentmodule:: _pytest.monkeypatch
-Running test written for nose
+Running tests written for nose
 =======================================
 
 .. include:: links.inc
 
 .. _`cmdunregister`:
 
-deactivate / unregister a plugin by name
+Deactivating / unregistering a plugin by name
 ----------------------------------------------------------------------------
 
 You can prevent plugins from loading or unregister them::
 py.test hook reference
 ====================================
 
-hook specification and validation
+Hook specification and validation
 -----------------------------------------
 
 py.test calls hook functions to implement initialization, running,
 by simply not specifying them.  If you mistype argument names or the
 hook name itself you get an error showing the available arguments.
 
-initialisation, command line and configuration hooks
+Initialisation, command line and configuration hooks
 --------------------------------------------------------------------
 
 .. currentmodule:: _pytest.hookspec
 .. autofunction:: pytest_configure
 .. autofunction:: pytest_unconfigure
 
-generic "runtest" hooks
+Generic "runtest" hooks
 ------------------------------
 
 All all runtest related hooks receive a :py:class:`pytest.Item` object.
 The :py:mod:`_pytest.terminal` reported specifically uses
 the reporting hook to print information about a test run.
 
-collection hooks
+Collection hooks
 ------------------------------
 
 py.test calls the following hooks for collecting files and directories:
 .. autofunction:: pytest_pycollect_makeitem
 
 
-reporting hooks
+Reporting hooks
 ------------------------------
 
 Session related reporting hooks:
 
-asserting deprecation and other warnings.
+Asserting deprecation and other warnings.
 =====================================================
 
-recwarn function argument
+The recwarn function argument
 ------------------------------------
 
 You can use the ``recwarn`` funcarg to assert that code triggers
 * ``pop(category=None)``: return last warning matching the category.
 * ``clear()``: clear list of warnings
 
-ensuring a function triggers a deprecation warning
+Ensuring a function triggers a deprecation warning
 -------------------------------------------------------
 
 You can also call a global helper for checking
 .. _`skip and xfail`:
 
-skip and xfail: dealing with tests that can not succeed
+Skip and xfail: dealing with tests that can not succeed
 =====================================================================
 
 If you have test functions that cannot be run on certain platforms
     def test_function():
         ...
 
-skip all test functions of a class
+Skip all test functions of a class
 --------------------------------------
 
 As with all function :ref:`marking <mark>` you can skip test functions at the
 
 .. _xfail:
 
-mark a test function as expected to fail
+Mark a test function as expected to fail
 -------------------------------------------------------
 
 You can use the ``xfail`` marker to indicate that you
 
 .. _`evaluation of skipif/xfail conditions`:
 
-evaluation of skipif/xfail expressions
+Evaluation of skipif/xfail expressions
 ----------------------------------------------------
 
 .. versionadded:: 2.0.2
         ...
 
 
-imperative xfail from within a test or setup function
+Imperative xfail from within a test or setup function
 ------------------------------------------------------
 
 If you cannot declare xfail-conditions at import time
             pytest.xfail("unsupported configuration")
 
 
-skipping on a missing import dependency
+Skipping on a missing import dependency
 --------------------------------------------------
 
 You can use the following import helper at module level
 
 The version will be read from the specified module's ``__version__`` attribute.
 
-imperative skip from within a test or setup function
+Imperative skip from within a test or setup function
 ------------------------------------------------------
 
 If for some reason you cannot declare skip-conditions
 
 .. _`funcargs`: funcargs.html
 
-tutorial examples and blog postings
+Tutorial examples and blog postings
 ---------------------------------------------
 
 .. _`tutorial1 repository`: http://bitbucket.org/hpk42/pytest-tutorial1/
 .. _`pycon 2010 tutorial PDF`: http://bitbucket.org/hpk42/pytest-tutorial1/raw/tip/pytest-basic.pdf
 
-basic usage and funcargs:
+Basic usage and funcargs:
 
 - `pycon 2010 tutorial PDF`_ and `tutorial1 repository`_
 
-function arguments:
+Function arguments:
 
 - :ref:`mysetup`
 - `application setup in test functions with funcargs`_
 - `monkey patching done right`_ (blog post, consult `monkeypatch
   plugin`_ for actual 1.0 API)
 
-test parametrization:
+Test parametrization:
 
 - `generating parametrized tests with funcargs`_
 - `test generators and cached setup`_
 - `parametrizing tests, generalized`_ (blog post)
 - `putting test-hooks into local or global plugins`_ (blog post)
 
-assertion introspection
+Assertion introspection:
 
 - `(07/2011) Behind the scenes of py.test's new assertion rewriting
   <http://pybites.blogspot.com/2011/07/behind-scenes-of-pytests-new-assertion.html>`_ 
 
-distributed testing:
+Distributed testing:
 
 - `simultaneously test your code on all platforms`_ (blog entry)
 
-plugin specific examples:
+Plugin specific examples:
 
 - `skipping slow tests by default in py.test`_ (blog entry)
 
 .. _`generating parametrized tests with funcargs`: funcargs.html#test-generators
 .. _`test generators and cached setup`: http://bruynooghe.blogspot.com/2010/06/pytest-test-generators-and-cached-setup.html
 
-conference talks and tutorials
+Conference talks and tutorials
 ----------------------------------------
 
 - `ep2009-rapidtesting.pdf`_ tutorial slides (July 2009):
 
 .. _`tmpdir handling`:
 
-temporary directories and files
+Temporary directories and files
 ================================================
 
-the 'tmpdir' test function argument
+The 'tmpdir' test function argument
 -----------------------------------
 
 You can use the ``tmpdir`` function argument which will
 
 .. _`base temporary directory`:
 
-the default base temporary directory
+The default base temporary directory
 -----------------------------------------------
 
 Temporary directories are by default created as sub-directories of
 
 .. _`unittest.TestCase`:
 
-unittest.TestCase support
+Support for unittest.TestCase
 =====================================================================
 
 py.test has limited support for running Python `unittest.py style`_ tests.
 
 .. _cmdline:
 
-calling pytest through ``python -m pytest``
+Calling pytest through ``python -m pytest``
 -----------------------------------------------------
 
 .. versionadded:: 2.0
     py.test -x            # stop after first failure
     py.test -maxfail=2    # stop after two failures
 
-specifying tests / selecting tests
+Specifying tests / selecting tests
 ---------------------------------------------------
 
 Several test run options::
 In previous versions you could only enter PDB tracing if
 you disable capturing on the command line via ``py.test -s``.
 
-creating JUnitXML format files
+Creating JUnitXML format files
 ----------------------------------------------------
 
 To create result files which can be read by Hudson_ or other Continuous
 
 to create an XML file at ``path``.
 
-creating resultlog format files
+Creating resultlog format files
 ----------------------------------------------------
 
 To create plain-text machine-readable result files you can issue::
 .. _`PyPy-test`: http://codespeak.net:8099/summary
 
 
-send test report to pocoo pastebin service
+Sending test report to pocoo pastebin service
 -----------------------------------------------------
 
 **Creating a URL for each test failure**::
 
 Currently only pasting to the http://paste.pocoo.org service is implemented.
 
-calling pytest from Python code
+Calling pytest from Python code
 ----------------------------------------------------
 
 .. versionadded:: 2.0

doc/xunit_setup.txt

 .. _xunitsetup:
 
 ====================================
-extended xUnit style setup fixtures
+Extended xUnit style setup fixtures
 ====================================
 
 .. _`funcargs`: funcargs.html
 handling by optionally calling per-module and per-class hooks.
 
 
-module level setup/teardown
+Module level setup/teardown
 =============================================
 
 If you have multiple test functions and test classes in a single
             with a setup_module method.
         """
 
-class level setup/teardown
+Class level setup/teardown
 =============================================
 
 Similarly, the following methods are called at class level before
             with a call to setup_class.
         """
 
-method and function level setup/teardown
+Method and function level setup/teardown
 =============================================
 
 Similarly, the following methods are called around each method invocation::