From 29c42e357d02883ee36894f6087a811e23441d9d Mon Sep 17 00:00:00 2001
From: Gregory Szorc <gregory.szorc@gmail.com>
Date: Sun, 20 Apr 2014 10:28:35 -0700
Subject: [PATCH] run-tests: add some docstrings

---
 tests/run-tests.py | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/tests/run-tests.py b/tests/run-tests.py
index 4f83bb49cb..72c2ee1add 100755
--- a/tests/run-tests.py
+++ b/tests/run-tests.py
@@ -128,6 +128,7 @@ def parselistfiles(files, listtype, warn=True):
     return entries
 
 def getparser():
+    """Obtain the OptionParser used by the CLI."""
     parser = optparse.OptionParser("%prog [options] [tests]")
 
     # keep these sorted
@@ -208,6 +209,7 @@ def getparser():
     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 @@ class Test(object):
             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")