Add module and class docstrings

diff --git a/jenkinsapi/command_line/__init__.py b/jenkinsapi/command_line/__init__.py
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..bbea7234266f7276f383e78fbb5ba6b293807986 100644 (file)
--- a/jenkinsapi/command_line/__init__.py
+++ b/jenkinsapi/command_line/__init__.py
@@ -0,0 +1,3 @@
+"""
+__init__,py for commandline module
+"""

diff --git a/jenkinsapi/command_line/jenkins_invoke.py b/jenkinsapi/command_line/jenkins_invoke.py
index b466d7a5c6b949236bb4aae606830f14db3401ab..ef2b742c33b1724fb37f0e5b62bf0384a23cdb84 100644 (file)
--- a/jenkinsapi/command_line/jenkins_invoke.py
+++ b/jenkinsapi/command_line/jenkins_invoke.py
@@ -1,3 +1,7 @@
+"""
+jenkinsapi class for invoking Jenkins
+"""
+
 import os
 import sys
 import logging

diff --git a/jenkinsapi/exceptions.py b/jenkinsapi/exceptions.py
index 65d9aeb8beda35d32bfcd286e6e809e07aab7769..48539cc932a6b720da2eeb43b68529d945b88d0c 100644 (file)
--- a/jenkinsapi/exceptions.py
+++ b/jenkinsapi/exceptions.py
@@ -1,3 +1,8 @@
+"""
+Module for exceptions specialized for jenkinsapi
+"""
+
+
 class JenkinsAPIException(Exception):
     """
     Base class for all errors

diff --git a/jenkinsapi/fingerprint.py b/jenkinsapi/fingerprint.py
index 7ca13b7caa3bd56fb9d6e369ec448704eb3814b6..539c10fa8381500cecc737d30238fd06cd3a67f1 100644 (file)
--- a/jenkinsapi/fingerprint.py
+++ b/jenkinsapi/fingerprint.py
@@ -1,3 +1,7 @@
+"""
+Module for jenkinsapi Fingerprint
+"""
+
 from jenkinsapi.jenkinsbase import JenkinsBase
 from jenkinsapi.exceptions import ArtifactBroken
 

diff --git a/jenkinsapi/invocation.py b/jenkinsapi/invocation.py
index b305f0a2705838aed54a5ba42c955eef24e9d073..f578dabc31c4b575c6f39c66b49fefaef81cc8a0 100644 (file)
--- a/jenkinsapi/invocation.py
+++ b/jenkinsapi/invocation.py
@@ -1,3 +1,7 @@
+"""
+Module for Jenkinsapi Invocation object
+"""
+
 import time
 import datetime
 from jenkinsapi.exceptions import UnknownQueueItem, TimeOut

diff --git a/jenkinsapi/jenkins.py b/jenkinsapi/jenkins.py
index bfd4aa28577662412245510c1bfef6a008520ede..9b61d85612ab443226350addc3cfce486d8220d5 100644 (file)
--- a/jenkinsapi/jenkins.py
+++ b/jenkinsapi/jenkins.py
@@ -1,3 +1,8 @@
+"""
+Module for jenkinsapi Jenkins object
+"""
+
+
 import json
 import urllib
 import logging

diff --git a/jenkinsapi/jenkinsbase.py b/jenkinsapi/jenkinsbase.py
index f2b323808853b1814c26226b0985dae889ec639f..5fd59abe14dd8dfaf3b9554836287ad37bae5776 100644 (file)
--- a/jenkinsapi/jenkinsbase.py
+++ b/jenkinsapi/jenkinsbase.py
@@ -1,3 +1,7 @@
+"""
+Module for JenkinsBase class
+"""
+
 import logging
 from jenkinsapi import config
 from jenkinsapi.exceptions import JenkinsAPIException

diff --git a/jenkinsapi/job.py b/jenkinsapi/job.py
index 548de72c39cc39e7acdb55bbf0fd5043f9f5ba9f..de3494cbbb40f6a588d681db63601cfa3db8a7ce 100644 (file)
--- a/jenkinsapi/job.py
+++ b/jenkinsapi/job.py
@@ -1,3 +1,7 @@
+"""
+Module for jenkinsapi Job
+"""
+
 import json
 import logging
 import urlparse

diff --git a/jenkinsapi/mutable_jenkins_thing.py b/jenkinsapi/mutable_jenkins_thing.py
index b99eddf9cb446f167b16a707e8015a119e1ddfe0..2a8a3f6e3368928916a781ecad145f5679bedb61 100644 (file)
--- a/jenkinsapi/mutable_jenkins_thing.py
+++ b/jenkinsapi/mutable_jenkins_thing.py
@@ -1,3 +1,7 @@
+"""
+Module for MutableJenkinsThing
+"""
+
 class MutableJenkinsThing(object):
     """
     A mixin for certain mutable objects which can be renamed and deleted.

diff --git a/jenkinsapi/node.py b/jenkinsapi/node.py
index 3d804f6b5e18e459d9e8aa9f139e00f754e60ed5..e2409f0a1f0cc1684e6bcd7db787b745fa7ef7bd 100644 (file)
--- a/jenkinsapi/node.py
+++ b/jenkinsapi/node.py
@@ -1,3 +1,7 @@
+"""
+Module for jenkinsapi Node class
+"""
+
 from jenkinsapi.jenkinsbase import JenkinsBase
 import logging
 import urllib

diff --git a/jenkinsapi/nodes.py b/jenkinsapi/nodes.py
index 40950310619ad8a24f120f1c5ab22ee4dcf48cc5..56a50682cfac264a82b1c12d4c3069dcdbf1a025 100644 (file)
--- a/jenkinsapi/nodes.py
+++ b/jenkinsapi/nodes.py
@@ -1,3 +1,7 @@
+"""
+Module for jenkinsapi nodes
+"""
+
 import logging
 from jenkinsapi.node import Node
 from jenkinsapi.exceptions import UnknownNode

diff --git a/jenkinsapi/plugin.py b/jenkinsapi/plugin.py
index 17f48d60490f8c81902bd06c4172eb00c2e35b87..44d542bdc57725ef9cd17b2155622764edd22eaf 100644 (file)
--- a/jenkinsapi/plugin.py
+++ b/jenkinsapi/plugin.py
@@ -1,4 +1,12 @@
+"""
+Module for jenkinsapi Plugin
+"""
+
 class Plugin(object):
+    """
+    Plugin class
+    """
+
     def __init__(self, plugin_dict):
         assert(isinstance(plugin_dict, dict))
         self.__dict__ = plugin_dict

diff --git a/jenkinsapi/plugins.py b/jenkinsapi/plugins.py
index a5092876c08ec2ff776eab08128d50e5432fc09f..ea38b5d31a5ea0a08fd951f8ee01f4d934ee4a13 100644 (file)
--- a/jenkinsapi/plugins.py
+++ b/jenkinsapi/plugins.py
@@ -1,3 +1,7 @@
+"""
+jenkinsapi plugins
+"""
+
 import logging
 
 from jenkinsapi.jenkinsbase import JenkinsBase
@@ -8,6 +12,9 @@ log = logging.getLogger(__name__)
 
 
 class Plugins(JenkinsBase):
+    """
+    Plugins class for jenkinsapi
+    """
     def __init__(self, url, jenkins_obj):
         self.jenkins_obj = jenkins_obj
         JenkinsBase.__init__(self, url)

diff --git a/jenkinsapi/queue.py b/jenkinsapi/queue.py
index 8aa80e16091a060b1901cbad9518aaeb61cd34f0..5c5b506fe334123dc1b3d6ffb500e1027e4cf0d6 100644 (file)
--- a/jenkinsapi/queue.py
+++ b/jenkinsapi/queue.py
@@ -1,3 +1,7 @@
+"""
+Queue module for jenkinsapi
+"""
+
 from jenkinsapi.jenkinsbase import JenkinsBase
 from jenkinsapi.exceptions import UnknownQueueItem
 import logging

diff --git a/jenkinsapi/result.py b/jenkinsapi/result.py
index b643ed73ed0aa4a04dec44cfc3b3bd6425bc0b7c..862999b2f40f859093303dfc88eafc68cc2c8184 100644 (file)
--- a/jenkinsapi/result.py
+++ b/jenkinsapi/result.py
@@ -1,8 +1,13 @@
+"""
+Module for jenkinsapi Result
+"""
+
 class Result(object):
-    def __init__(self, **kwargs):
-        """
+    """
+    Result class
+    """
 
-        """
+    def __init__(self, **kwargs):
         self.__dict__.update(kwargs)
 
     def __str__(self):

diff --git a/jenkinsapi/result_set.py b/jenkinsapi/result_set.py
index b635e4ece2bfd48a93b1e716d4ae04aae538e9b0..88fd1e99c858113c27214135c23aa092f7989a22 100644 (file)
--- a/jenkinsapi/result_set.py
+++ b/jenkinsapi/result_set.py
@@ -1,3 +1,7 @@
+"""
+Module for jenkinsapi ResultSet
+"""
+
 from jenkinsapi.jenkinsbase import JenkinsBase
 from jenkinsapi.result import Result
 

diff --git a/jenkinsapi/utils/__init__.py b/jenkinsapi/utils/__init__.py
index e69de29bb2d1d6434b8b29ae775ad8c2e48c5391..1cf8c6e6d9fcb1d46fc8e8b7a92085e9abca890a 100644 (file)
--- a/jenkinsapi/utils/__init__.py
+++ b/jenkinsapi/utils/__init__.py
@@ -0,0 +1,3 @@
+"""
+Module __init__ for utils
+"""

diff --git a/jenkinsapi/utils/requester.py b/jenkinsapi/utils/requester.py
index 72b4db4a547be9e20003dfe55322acee9f0c319d..290fe6cb3e928b57f1a56aa8876b4862fdd47ece 100644 (file)
--- a/jenkinsapi/utils/requester.py
+++ b/jenkinsapi/utils/requester.py
@@ -1,3 +1,7 @@
+"""
+Module for jenkinsapi requester (which is a wrapper around python-requests)
+"""
+
 import requests
 from jenkinsapi.exceptions import JenkinsAPIException
 # import logging

diff --git a/jenkinsapi/view.py b/jenkinsapi/view.py
index ff2f03d5c5a7796e3722b9ab808a72f3aba0ef61..5312d06f08bbad697a58a7b36d6a7707bebd461a 100644 (file)
--- a/jenkinsapi/view.py
+++ b/jenkinsapi/view.py
@@ -1,3 +1,6 @@
+"""
+Module for jenkinsapi views
+"""
 import urllib
 import logging
 
@@ -9,6 +12,10 @@ log = logging.getLogger(__name__)
 
 
 class View(JenkinsBase):
+    """
+    View class
+    """
+
     def __init__(self, url, name, jenkins_obj):
         self.name = name
         self.jenkins_obj = jenkins_obj

diff --git a/jenkinsapi/views.py b/jenkinsapi/views.py
index 0dba4ddcdb11afa529e690432fe3497f6161d987..4926f5b6e5d647b1e2c6c8ba0788bf64b3a0b88a 100644 (file)
--- a/jenkinsapi/views.py
+++ b/jenkinsapi/views.py
@@ -1,3 +1,7 @@
+"""
+Module for jenkinsapi Views
+"""
+
 import logging
 import json
 from jenkinsapi.view import View
@@ -6,6 +10,9 @@ log = logging.getLogger(__name__)
 
 
 class Views(object):
+    """
+    An abstraction on a Jenkins object's views
+    """
 
     # TODO @lechat 20130702: Add check that plugin for view actually exists in Jenkins
     LIST_VIEW = 'hudson.model.ListView'
@@ -14,10 +21,6 @@ class Views(object):
     DASHBOARD_VIEW = 'hudson.plugins.view.dashboard.Dashboard'
     PIPELINE_VIEW = 'au.com.centrumsystems.hudson.plugin.buildpipeline.BuildPipelineView'
 
-    """
-    An abstraction on a Jenkins object's views
-    """
-
     def __init__(self, jenkins):
         self.jenkins = jenkins