Comments and Documentation

This change adds a ton of comments and documentation across all the code.

Change-Id: Ifee0a2f534e8584f14b0f13af4dda8dc70eb7553
Signed-off-by: Parker Berberian <pberberian@iol.unh.edu>

1 files changed, 7 insertions, 4 deletions

diff --git a/src/resource_inventory/resource_manager.py b/src/resource_inventory/resource_manager.py
index 7df4263..34c7be3 100644
--- a/src/resource_inventory/resource_manager.py
+++ b/src/resource_inventory/resource_manager.py
@@ -44,10 +44,10 @@ class ResourceManager:
 
     def hostsAvailable(self, grb):
         """
-        This method will check if the given GenericResourceBundle
-        is available. No changes to the database
-        """
+        Check if the given GenericResourceBundle is available.
 
+        No changes to the database
+        """
         # count up hosts
         profile_count = {}
         for host in grb.getResources():
@@ -90,7 +90,10 @@ class ResourceManager:
 
     def convertResourceBundle(self, genericResourceBundle, config=None):
         """
-        Takes in a GenericResourceBundle and 'converts' it into a ResourceBundle
+        Convert a GenericResourceBundle into a ResourceBundle.
+
+        Takes in a genericResourceBundle and reserves all the
+        Resources needed and returns a completed ResourceBundle.
         """
         resource_bundle = ResourceBundle.objects.create(template=genericResourceBundle)
         generic_hosts = genericResourceBundle.getResources()