# HG changeset patch # User Gregory Szorc # Date 2014-04-20 17:28:35 # Node ID 772ed56e2519a8cdd48d03e492249e805365a8da # Parent 4b8ffe3abdd2180fe9d0441398cb293beec87289 run-tests: add some docstrings diff --git a/tests/run-tests.py b/tests/run-tests.py --- a/tests/run-tests.py +++ b/tests/run-tests.py @@ -128,6 +128,7 @@ def parselistfiles(files, listtype, warn 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")