updated documentation to include enthought in credits, instructions for running

Darren Dale · Darren Dale · commit adf0dbdb54f4 · 2009-01-06T12:59:14.000-05:00
unit tests with code coverage
diff --git a/doc/devel/devnotes.rst b/doc/devel/devnotes.rst
@@ -2,9 +2,9 @@ Development
 ===========
 
 In order to work on quantities development, after installing the dependencies,
-it is recommended to do the following:
+it is recommended to do the following::
 
-python setup.py develop
+  python setup.py develop
 
 This uses setuptools to install a link in your site-packages directory which
 points to your source directory. This allows you to make changes in the source
@@ -13,3 +13,13 @@ changing extension code, which needs to be compiled, you will need to run
 "python setup.py develop" again. Also note that executable scripts are copied
 to their install directory, rather than being linked, so you need to run
 "python setup.py develop" after editing scripts.
+
+Unit tests are collected by the nose package, and can be run with the following::
+
+  python setup.py nosetests --with-coverage --cover-package=quantities \
+  --cover-erase --cover-tests
+
+This assumes you have both nose_ and coverage_ installed on your system. 
+
+.. _nose: http://somethingaboutorange.com/mrl/projects/nose
+.. _coverage: http://nedbatchelder.com/code/modules/rees-coverage.html
diff --git a/doc/users/credits.rst b/doc/users/credits.rst
@@ -16,6 +16,10 @@ Charles Doutriaux
   wrote the python wrapper for unit conversions with the UDUnits 
   library (no longer used)
 
+Enthought Inc.
+  the original units registry was developed at Enthought for the 
+  Enthought Tool Suite.
+
 John Salvatier
   added support for the Quantity iterator, contributed to support for 
   simplified representations of units, comparison operators, and 
diff --git a/doc/users/installation.rst b/doc/users/installation.rst
@@ -15,6 +15,7 @@ The following are also recommended:
 
 * setuptools_ (version 0.6c8 or later, for developers and unit tests)
 * nose_ (for unit tests)
+* coverage_ (for unit tests)
 
 Source Code Installation
 ========================
@@ -41,6 +42,7 @@ website.
 .. _Python: http://www.python.org/
 .. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools
 .. _NumPy: http://www.scipy.org
-.. _Nose: http://somethingaboutorange.com/mrl/projects/nose
+.. _nose: http://somethingaboutorange.com/mrl/projects/nose
+.. _coverage: http://nedbatchelder.com/code/modules/rees-coverage.html
 .. _PyPi: http://pypi.python.org/pypi/quantities
 .. _launchpad: https://launchpad.net/python-quantities
