Added docstrings

Change-Id: I9d590893dbec917897b3ac126f738ade08387af5
Signed-off-by: Ed Bartosh <eduard.bartosh@intel.com>

diff --git a/job_pre_release.py b/job_pre_release.py
index 1952a20..8069e6b 100755 (executable)
--- a/job_pre_release.py
+++ b/job_pre_release.py
@@ -1,7 +1,9 @@
 #!/usr/bin/env python
 # vim: ai ts=4 sts=4 et sw=4
 
-"""This job will help submit the changes to a temporary OBS project when SR created.
+"""
+This Jenkins job submits the changes to a
+temporary OBS project when SR is created.
 """
 
 import os
@@ -15,6 +17,7 @@ from common.buildtrigger import trigger_info, trigger_next
 from testprojects.prerelease import PreRelease, PreRelease2
 
 def create(prerelease, bservice, git_project):
+    """Create pre-release OBS project."""
     prjdir = os.path.join(os.getenv('WORKSPACE'), git_project)
 
     # clone gerrit project to local dir
@@ -22,11 +25,10 @@ def create(prerelease, bservice, git_project):
         exit(1)
 
     mygit = Git(prjdir)
-
     prerelease.create(bservice, mygit)
 
 def cleanup(prerelease, bservice):
-
+    """Remove pre-release OBS project."""
     bservice.cleanup()
     print "OBS Project %s  deleted" %prerelease.obs_project
 
@@ -40,7 +42,7 @@ def cleanup(prerelease, bservice):
         print "WARN: Temporary repo doesn't exist!"
 
 def create_images(project, prerelease):
-
+    """Create images using live prerelease repository."""
     linked, depended = prerelease.get_parent_project()
 
     builddata = BuildData()
@@ -110,6 +112,7 @@ def create_images(project, prerelease):
                          image_info)
 
 def main(action):
+    """Script entry point."""
     print '---[JOB STARTED: %s ]-------------------------', action
 
     content = trigger_info(os.getenv("TRIGGER_INFO"))