summaryrefslogtreecommitdiff
path: root/nose/plugins
diff options
context:
space:
mode:
authorJason Pellerin <jpellerin@gmail.com>2009-05-02 14:04:16 -0400
committerJason Pellerin <jpellerin@gmail.com>2009-05-02 14:04:16 -0400
commitdda7fc1323426a21faf1d3997c6b2dcb8fa0fc4e (patch)
treeaf14785bbc3f3e137dc3cd971c31c5734678cf85 /nose/plugins
parent3adce92a0bb1b8ef06642ba61c850e47c8e07952 (diff)
downloadnose-dda7fc1323426a21faf1d3997c6b2dcb8fa0fc4e.tar.gz
Doc updates
Diffstat (limited to 'nose/plugins')
-rw-r--r--nose/plugins/doctests.py9
-rw-r--r--nose/plugins/failuredetail.py4
-rw-r--r--nose/plugins/multiprocess.py3
3 files changed, 7 insertions, 9 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
diff --git a/nose/plugins/failuredetail.py b/nose/plugins/failuredetail.py
index 7dbc6c7..c68b095 100644
--- a/nose/plugins/failuredetail.py
+++ b/nose/plugins/failuredetail.py
@@ -1,6 +1,6 @@
"""
This plugin provides assert introspection. When the plugin is enabled
-and a test failure occurs, the traceback displayed with extra context
+and a test failure occurs, the traceback is displayed with extra context
around the line in which the exception was raised. Simple variable
substitution is also performed in the context output to provide more
debugging information.
@@ -11,7 +11,7 @@ from nose.inspector import inspect_traceback
class FailureDetail(Plugin):
"""
- Plugin that provides assert introspection.
+ Plugin that provides extra information in tracebacks of test failures.
"""
score = 600 # before capture
diff --git a/nose/plugins/multiprocess.py b/nose/plugins/multiprocess.py
index f825cd8..27711b3 100644
--- a/nose/plugins/multiprocess.py
+++ b/nose/plugins/multiprocess.py
@@ -6,8 +6,7 @@ The multiprocess plugin enables you to distribute your test run among a set of
worker processes that run tests in parallel. This can speed up CPU-bound test
runs (as long as the number of work processeses is around the number of
processors or cores available), but is mainly useful for IO-bound tests that
-spend most of their time waiting for data to arrive from someplace else and
-would benefit from massive parallelization.
+spend most of their time waiting for data to arrive from someplace else.
.. note ::