From b4bf5e01e4ca0eab0b52f2f3fa205683f64f5ab6 Mon Sep 17 00:00:00 2001
From: Robert Collins <robertc@robertcollins.net>
Date: Sat, 19 Sep 2009 16:39:00 +1000
Subject: Move python API documentation into the subunit pydoc.

---
 python/subunit/run.py | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

(limited to 'python/subunit/run.py')

diff --git a/python/subunit/run.py b/python/subunit/run.py
index 5dad84a..66b9633 100755
--- a/python/subunit/run.py
+++ b/python/subunit/run.py
@@ -17,6 +17,11 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
+"""Run a unittest testcase reporting results as subunit.
+
+  $ python -m subunit.run mylib.tests.test_suite
+"""
+
 import sys
 
 from subunit import TestProtocolClient
@@ -36,7 +41,7 @@ class SubunitTestRunner(object):
 if __name__ == '__main__':
     import optparse
     from unittest import TestProgram
-    parser = optparse.OptionParser("subunitrun <tests>")
+    parser = optparse.OptionParser(__doc__)
     args = parser.parse_args()[1]
     runner = SubunitTestRunner()
     program = TestProgram(module=None, argv=[sys.argv[0]] + args,
-- 
cgit v1.2.1