Skip to content

Commit

Permalink
update pytest docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Ben Weaver committed Apr 10, 2009
1 parent d277655 commit 6454b76
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion docs/scripts.rst
Expand Up @@ -7,7 +7,7 @@ These scripts are included with the :mod:`md` module.
``pytest`` -- run :mod:`test` suites
------------------------------------

usage: pytest [options] module ...
usage: pytest [options] module-or-file ...

This script runs tests found by :func:`test.pkg_suites` for the given
modules. This makes running tests for any package or module very
Expand All @@ -32,6 +32,16 @@ easy. Run ``pytest --help`` to see the options. For example:
----------------------------------------------------------------------
Ran 3 tests in 0.087s
Doctest files can be tested just as easily.

.. code-block:: sh
%find docs -name '*.rst' | xargs pytest
----------------------------------------------------------------------
Ran 9 tests in 1.683s
OK
No special support is required by the modules being tested. Here's an
example of testing the ``pickle`` and ``pickletools`` modules build
into Python.
Expand Down

0 comments on commit 6454b76

Please sign in to comment.