Python Better Docstrings

This commit is contained in:
Gormogon 2015-02-20 14:54:25 -05:00 committed by Teo Mrnjavac
parent b8b41bdfdd
commit 113d9db7cb
15 changed files with 295 additions and 11 deletions

View file

@ -35,6 +35,13 @@ except ImportError:
class Job:
"""
:param working_path:
:param doc:
:param cfg_doc:
"""
def __init__(self, working_path, doc, cfg_doc):
self.module_name = doc["name"]
self.pretty_name = "Testing job " + doc["name"]
@ -42,10 +49,19 @@ class Job:
self.configuration = cfg_doc
def setprogress(self, progress):
"""
:param progress:
"""
print("Job set progress to {}%.".format(progress * 100))
def main():
"""
:return:
"""
parser = argparse.ArgumentParser()
parser.add_argument("moduledir",
help="Dir containing the Python module.")