Add some more comments.
authorsalimfadhley <sal@stodge.org>
Wed, 16 Oct 2013 23:29:14 +0000 (00:29 +0100)
committersalimfadhley <sal@stodge.org>
Wed, 16 Oct 2013 23:29:14 +0000 (00:29 +0100)
jenkinsapi/build.py

index f5e59c0..c0cfade 100644 (file)
@@ -1,5 +1,11 @@
 """
-Build API methods
+A jenkins build represents a single execution of a Jenkins Job.
+
+Builds can be thought of as the second level of the jenkins heirarchy
+beneath Jobs. Builds can have state, such as whether they are running or
+not. They can also have outcomes, such as wether they passed or failed.
+
+Build objects can be associated with Results and Artifacts.g
 """
 
 import time