1 files changed, 17 insertions, 8 deletions
diff --git a/src/lib/Bcfg2/Server/Lint/RequiredAttrs.py b/src/lib/Bcfg2/Server/Lint/RequiredAttrs.py
index 6e47acfc0..6ffdd33a0 100644
--- a/src/lib/Bcfg2/Server/Lint/RequiredAttrs.py
+++ b/src/lib/Bcfg2/Server/Lint/RequiredAttrs.py
@@ -1,5 +1,5 @@
-""" verify attributes for configuration entries that cannot be
-verified with an XML schema alone"""
+""" Verify attributes for configuration entries that cannot be
+verified with an XML schema alone. """
 
 import os
 import re
@@ -15,7 +15,8 @@ except ImportError:
     HAS_GENSHI = False
 
 
-# format verifying functions
+# format verifying functions.  TODO: These should be moved into XML
+# schemas where possible.
 def is_filename(val):
     """ Return True if val is a string describing a valid full path
     """
@@ -53,8 +54,8 @@ def is_device_mode(val):
 
 
 class RequiredAttrs(Bcfg2.Server.Lint.ServerPlugin):
-    """ verify attributes for configuration entries that cannot be
-    verified with an XML schema alone """
+    """ Verify attributes for configuration entries that cannot be
+    verified with an XML schema alone. """
     def __init__(self, *args, **kwargs):
         Bcfg2.Server.Lint.ServerPlugin.__init__(self, *args, **kwargs)
         self.required_attrs = dict(
@@ -135,7 +136,8 @@ class RequiredAttrs(Bcfg2.Server.Lint.ServerPlugin):
                 "extra-attrs": "warning"}
 
     def check_packages(self):
-        """ check package sources for Source entries with missing attrs """
+        """ Check Packages sources for Source entries with missing
+        attributes. """
         if 'Packages' not in self.core.plugins:
             return
 
@@ -175,7 +177,8 @@ class RequiredAttrs(Bcfg2.Server.Lint.ServerPlugin):
                                                     rules.name))
 
     def check_bundles(self):
-        """ check bundles for BoundPath entries with missing attrs """
+        """ Check bundles for BoundPath entries with missing
+        attrs. """
         if 'Bundler' not in self.core.plugins:
             return
 
@@ -194,7 +197,13 @@ class RequiredAttrs(Bcfg2.Server.Lint.ServerPlugin):
                     self.check_entry(path, bundle.name)
 
     def check_entry(self, entry, filename):
-        """ generic entry check """
+        """ Generic entry check.
+
+        :param entry: The XML entry to check for missing attributes.
+        :type entry: lxml.etree._Element
+        :param filename: The filename the entry came from
+        :type filename: string
+        """
         if self.HandlesFile(filename):
             name = entry.get('name')
             tag = entry.tag