From 28aaa92f49afd59bf63b3d2eb5a8e77336094dfd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Jouni=20K=2E=20Sepp=C3=A4nen?= <jks@iki.fi>
Date: Sun, 6 Mar 2011 17:45:45 +0200
Subject: [PATCH] Add standalone test script

Fix minor documentation bugs while documenting the script.
---
 doc/devel/coding_guide.rst | 31 +++++++++++++++++++++++--------
 tests.py                   | 17 +++++++++++++++++
 2 files changed, 40 insertions(+), 8 deletions(-)
 create mode 100755 tests.py

diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
index 6d3164d07244..405248c88b7b 100644
--- a/doc/devel/coding_guide.rst
+++ b/doc/devel/coding_guide.rst
@@ -5,7 +5,7 @@ Coding guide
 ************
 
 Committing changes
-------------------
+==================
 
 When committing changes to matplotlib, there are a few things to bear
 in mind.
@@ -358,7 +358,6 @@ object::
     print 'datafile', datafile
 
 
-.. _license-discussion:
 
 
 
@@ -376,17 +375,31 @@ please ignore it while we consolidate our testing to these locations.)
 Running the tests
 -----------------
 
-Running the tests is simple. Make sure you have nose installed and
-type from within Python::
+Running the tests is simple. Make sure you have nose installed and run
+the script :file:`tests.py` in the root directory of the distribution.
+The script can take any of the usual `nosetest arguments`_, such as
+
+===================  ===========
+``-v``               increase verbosity
+``-d``               detailed error messages
+``--with-coverage``  enable collecting coverage information
+===================  ===========
+
+To run a single test from the command line, you can provide a
+dot-separated path to the module followed by the function separated by
+a colon, eg.  (this is assuming the test is installed)::
+
+  python tests.py matplotlib.tests.test_simplification:test_clipping
+
+An alternative implementation that does not look at command line
+arguments works from within Python::
 
   import matplotlib
   matplotlib.test()
 
-To run a single test from the command line, you can provide
-a dot-separated path to the module and function, eg.
-(this is assuming the test is installed)::
 
-  nosetests matplotlib.tests.test_simplification:test_clipping
+.. _`nosetest arguments`: http://somethingaboutorange.com/mrl/projects/nose/1.0.0/usage.html
+
 
 
 Writing a simple test
@@ -482,6 +495,8 @@ Let's say you've added a new module named
 the list of default tests, append its name to ``default_test_modules``
 in :file:`lib/matplotlib/__init__.py`.
 
+.. _license-discussion:
+
 Licenses
 ========
 
diff --git a/tests.py b/tests.py
new file mode 100755
index 000000000000..a260be57d008
--- /dev/null
+++ b/tests.py
@@ -0,0 +1,17 @@
+#!/usr/bin/env python
+#
+# This allows running the matplotlib tests from the command line: e.g.
+# python tests.py -v -d
+# See http://somethingaboutorange.com/mrl/projects/nose/1.0.0/usage.html
+# for options.
+
+import nose
+from matplotlib.testing.noseclasses import KnownFailure
+from matplotlib import default_test_modules
+
+def run():
+    nose.main(addplugins=[KnownFailure()],
+              defaultTest=default_test_modules)
+
+if __name__ == '__main__':
+    run()