Merge pull request matplotlib#1470 from NelleV/test_coverage

pelson · pelson · commit d0cf23d54324 · 2012-11-19T07:58:19.000-08:00
Add ``test`` and ``test-coverage`` to Makefile
diff --git a/Makefile b/Makefile
@@ -44,6 +44,11 @@ jdh_doc_snapshot:
 	python make.py html latex sf sfpdf;
 
 
+test:
+	${PYTHON} tests.py
 
 
+test-coverage:
+	${PYTHON} tests.py --with-coverage --cover-package=matplotlib	
+
 
diff --git a/README.txt b/README.txt
@@ -1,3 +1,6 @@
+matplotlib
+==========
+
 matplotlib is a python 2D plotting library which produces publication
 quality figures in a variety of hardcopy formats and interactive
 environments across platforms. matplotlib can be used in python
@@ -6,4 +9,17 @@ application servers, and various graphical user interface toolkits.
 
 Home page: <http://matplotlib.org/>
 
+
+Installation
+=============
 For installation instructions and requirements, see the INSTALL file.
+
+Testing
+=======
+
+After installation, you can launch the test suite::
+
+  python tests.py
+
+Consider reading http://matplotlib.org/devel/coding_guide.html#testing for
+more information.
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
@@ -367,7 +367,7 @@ customizations to the nose testing infrastructure are in
 :mod:`matplotlib.testing`. (There is other old testing cruft around,
 please ignore it while we consolidate our testing to these locations.)
 
-.. _nose: http://somethingaboutorange.com/mrl/projects/nose/
+.. _nose: https://nose.readthedocs.org/en/latest/
 
 Requirements
 ------------
@@ -386,33 +386,34 @@ Running the tests
 
 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
-===================  ===========
+  ===================  ===========
+  ``-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)::
+  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
+    python tests.py matplotlib.tests.test_simplification:test_clipping
 
-An alternative implementation that does not look at command line
-arguments works from within Python::
+  An alternative implementation that does not look at command line
+  arguments works from within Python::
 
-  import matplotlib
-  matplotlib.test()
+    import matplotlib
+    matplotlib.test()
 
 
-.. _`nosetest arguments`: http://somethingaboutorange.com/mrl/projects/nose/1.0.0/usage.html
+  .. _`nosetest arguments`: http://somethingaboutorange.com/mrl/projects/nose/1.0.0/usage.html
 
 
-Running tests by any means other than `matplotlib.test()`
-does not load the nose "knownfailureif" (Known failing tests) plugin,
-causing known-failing tests to fail for real.
+  Running tests by any means other than `matplotlib.test()`
+  does not load the nose "knownfailureif" (Known failing tests) plugin,
+  causing known-failing tests to fail for real.
 
 Writing a simple test
 ---------------------
