diff options
author | Jason Pellerin <jpellerin@gmail.com> | 2009-05-02 14:04:16 -0400 |
---|---|---|
committer | Jason Pellerin <jpellerin@gmail.com> | 2009-05-02 14:04:16 -0400 |
commit | dda7fc1323426a21faf1d3997c6b2dcb8fa0fc4e (patch) | |
tree | af14785bbc3f3e137dc3cd971c31c5734678cf85 /nose/plugins/doctests.py | |
parent | 3adce92a0bb1b8ef06642ba61c850e47c8e07952 (diff) | |
download | nose-dda7fc1323426a21faf1d3997c6b2dcb8fa0fc4e.tar.gz |
Doc updates
Diffstat (limited to 'nose/plugins/doctests.py')
-rw-r--r-- | nose/plugins/doctests.py | 9 |
1 files changed, 4 insertions, 5 deletions
diff --git a/nose/plugins/doctests.py b/nose/plugins/doctests.py index 6b8cdd4..2f38c0a 100644 --- a/nose/plugins/doctests.py +++ b/nose/plugins/doctests.py @@ -1,8 +1,8 @@ """Use the Doctest plugin with ``--with-doctest`` or the NOSE_WITH_DOCTEST -environment variable to enable collection and execution of doctests_. -Because doctests are usually included in the tested package (instead of -being grouped into packages or modules of their own), nose only looks for -them in the non-test packages it discovers in the working directory. +environment variable to enable collection and execution of :mod:`doctests +<doctest>`. Because doctests are usually included in the tested package +(instead of being grouped into packages or modules of their own), nose only +looks for them in the non-test packages it discovers in the working directory. Doctests may also be placed into files other than python modules, in which case they can be collected and executed by using the ``--doctest-extension`` @@ -46,7 +46,6 @@ test. See :doc:`../doc_tests/test_doctest_fixtures/doctest_fixtures` for additional documentation and examples. -.. _doctests: http://docs.python.org/lib/module-doctest.html """ from __future__ import generators |