From: salimfadhley Date: Sat, 12 Oct 2013 17:00:46 +0000 (+0100) Subject: Add some missing doctext. X-Git-Tag: v0.2.23~84 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=73575b6fa323c132ca63277a902a4e486fa70004;p=tools%2Fpython-jenkinsapi.git Add some missing doctext. --- diff --git a/jenkinsapi/jobs.py b/jenkinsapi/jobs.py index 0801450..fe3bfad 100644 --- a/jenkinsapi/jobs.py +++ b/jenkinsapi/jobs.py @@ -1,3 +1,7 @@ +""" +This module implements the Jobs class, which is intended to be a container-like +interface for all of the jobs defined on a single Jenkins server. +""" import logging from jenkinsapi.job import Job from jenkinsapi.custom_exceptions import JenkinsAPIException @@ -6,7 +10,12 @@ log = logging.getLogger(__name__) class Jobs(object): - + """ + This class provides a container-like API which gives + access to all jobs defined on the Jenkins server. It behaves + like a dict in which keys are Job-names and values are actual + jenkinsapi.Job objects. + """ def __init__(self, jenkins): self.jenkins = jenkins