# HG changeset patch
# User Gregory Szorc <gregory.szorc@gmail.com>
# Date 1398014915 25200
# Node ID 772ed56e2519a8cdd48d03e492249e805365a8da
# Parent  4b8ffe3abdd2180fe9d0441398cb293beec87289
run-tests: add some docstrings

diff -r 4b8ffe3abdd2 -r 772ed56e2519 tests/run-tests.py
--- a/tests/run-tests.py	Sun Apr 20 10:24:00 2014 -0700
+++ b/tests/run-tests.py	Sun Apr 20 10:28:35 2014 -0700
@@ -128,6 +128,7 @@
     return entries
 
 def getparser():
+    """Obtain the OptionParser used by the CLI."""
     parser = optparse.OptionParser("%prog [options] [tests]")
 
     # keep these sorted
@@ -208,6 +209,7 @@
     return parser
 
 def parseargs(args, parser):
+    """Parse arguments with our OptionParser and validate results."""
     (options, args) = parser.parse_args(args)
 
     # jython is always pure
@@ -370,6 +372,10 @@
             shutil.rmtree(self._threadtmp, True)
 
     def run(self):
+        """Run this test instance.
+
+        This will return a tuple describing the result of the test.
+        """
         if not os.path.exists(self._path):
             return self.skip("Doesn't exist")