Updating attribute documentation

Author: Nathan Beittenmiller

SoftLayer/managers/cci.py

@@ -16,17 +16,17 @@
 class CCIManager(IdentifierMixin, object):
     """ Manage CCIs """
     def __init__(self, client):
+        #: A valid `SoftLayer.API.Client` object that will be used for all
+        #: actions.
         self.client = client
-        """ A valid `SoftLayer.API.Client` object that will be used for all
-        actions. """
+        #: Reference to the SoftLayer_Account API object.
         self.account = client['Account']
-        """ Reference to the SoftLayer_Account API object. """
+        #: Reference to the SoftLayer_Virtual_Guest API object.
         self.guest = client['Virtual_Guest']
-        """ Reference to the SoftLayer_Virtual_Guest API object. """
+        #: A list of resolver functions. Used primarily by the CLI to provide
+        #: a variety of methods for uniquely identifying an object such as
+        #: hostname and IP address.
         self.resolvers = [self._get_ids_from_ip, self._get_ids_from_hostname]
-        """ A list of resolver functions. Used primarily by the CLI to provide
-        a variety of methods for uniquely identifying an object such as
-        hostname and IP address."""
 
     def list_instances(self, hourly=True, monthly=True, tags=None, cpus=None,
                        memory=None, hostname=None, domain=None,

SoftLayer/managers/dns.py

@@ -13,26 +13,25 @@
 
 
 class DNSManager(IdentifierMixin, object):
-    """ Manage DNS zones. """
+    """ DNSManager initialization.
 
-    def __init__(self, client):
-        """ DNSManager initialization.
+    :param SoftLayer.API.Client client: the client instance
 
-        :param SoftLayer.API.Client client: the client instance
+    """
 
-        """
+    def __init__(self, client):
+        #: A valid `SoftLayer.API.Client` object that will be used for all
+        #: actions.
         self.client = client
-        """ A valid `SoftLayer.API.Client` object that will be used for all
-        actions. """
+        #: Reference to the SoftLayer_Dns_Domain API object.
         self.service = self.client['Dns_Domain']
-        """ Reference to the SoftLayer_Dns_Domain API object. """
+        #: Reference to the SoftLayer.Dns_Domain_ResourceRecord
+        #: API object.
         self.record = self.client['Dns_Domain_ResourceRecord']
-        """ Reference to the SoftLayer.Dns_Domain_ResourceRecord
-        API object. """
+        #: A list of resolver functions. Used primarily by the CLI to provide
+        #: a variety of methods for uniquely identifying an object such as zone
+        #: name.
         self.resolvers = [self._get_zone_id_from_name]
-        """ A list of resolver functions. Used primarily by the CLI to provide
-        a variety of methods for uniquely identifying an object such as zone
-        name """
 
     def _get_zone_id_from_name(self, name):
             results = self.client['Account'].getDomains(

SoftLayer/managers/firewall.py

@@ -24,15 +24,15 @@ def has_firewall(vlan):
 
 
 class FirewallManager(object):
-    def __init__(self, client):
-        """ Manages firewalls.
+    """ Manages firewalls.
 
-        :param SoftLayer.API.Client client: the API client instance
+    :param SoftLayer.API.Client client: the API client instance
 
-        """
+    """
+    def __init__(self, client):
+        #: A valid `SoftLayer.API.Client` object that will be used for all
+        #: actions.
         self.client = client
-        """ A valid `SoftLayer.API.Client` object that will be used for all
-        actions. """
 
     def get_firewalls(self):
         """ Returns a list of all firewalls on the account.

SoftLayer/managers/hardware.py

@@ -12,25 +12,24 @@
 
 
 class HardwareManager(IdentifierMixin, object):
-    """ Manages hardware devices. """
-
-    def __init__(self, client):
-        """ HardwareManager initialization.
+    """
+    Manages hardware devices.
 
-        :param SoftLayer.API.Client client: an API client instance
+    :param SoftLayer.API.Client client: an API client instance
+    """
 
-        """
+    def __init__(self, client):
+        #: A valid `SoftLayer.API.Client` object that will be used for all
+        #: actions.
         self.client = client
-        """ A valid `SoftLayer.API.Client` object that will be used for all
-        actions. """
+        #: Reference to the SoftLayer_Hardware_Server API object.
         self.hardware = self.client['Hardware_Server']
-        """ Reference to the SoftLayer_Hardware_Server API object. """
+        #: Reference to the SoftLayer_Account API object.
         self.account = self.client['Account']
-        """ Reference to the SoftLayer_Account API object. """
+        #: A list of resolver functions. Used primarily by the CLI to provide
+        #: a variety of methods for uniquely identifying an object such as
+        #: hostname and IP address.
         self.resolvers = [self._get_ids_from_ip, self._get_ids_from_hostname]
-        """ A list of resolver functions. Used primarily by the CLI to provide
-        a variety of methods for uniquely identifying an object such as
-        hostname and IP address."""
 
     def cancel_hardware(self, id, reason='unneeded', comment=''):
         """ Cancels the specified dedicated server.

SoftLayer/managers/network.py

@@ -13,13 +13,13 @@
 class NetworkManager(IdentifierMixin, object):
     """ Manage Networks """
     def __init__(self, client):
+        #: A valid `SoftLayer.API.Client` object that will be used for all
+        #: actions.
         self.client = client
-        """ A valid `SoftLayer.API.Client` object that will be used for all
-        actions. """
+        #: Reference to the SoftLayer_Account API object.
         self.account = client['Account']
-        """ Reference to the SoftLayer_Account API object. """
+        #: Reference to the SoftLayer_Network_Vlan object.
         self.vlan = client['Network_Vlan']
-        """ Reference to the SoftLayer_Network_Vlan object. """
 
     def get_vlan(self, id):
         """ Returns information about a single VLAN.

SoftLayer/managers/ssl.py

@@ -9,19 +9,18 @@
 
 
 class SSLManager(object):
-    """ Manages SSL certificates. """
+    """
+    Manages SSL certificates.
 
-    def __init__(self, client):
-        """ SSLManager initialization.
-
-        :param SoftLayer.API.Client client: an API client instance
+    :param SoftLayer.API.Client client: an API client instance
+    """
 
-        """
+    def __init__(self, client):
+        #: A valid `SoftLayer.API.Client` object that will be used for all
+        #: actions.
         self.client = client
-        """ A valid `SoftLayer.API.Client` object that will be used for all
-        actions. """
+        #: Reference to the SoftLayer_Security_Certificate API object.
         self.ssl = self.client['Security_Certificate']
-        """ Reference to the SoftLayer_Security_Certificate API object. """
 
     def list_certs(self, method='all'):
         """ List all certificates.