From bd19bd2edd612dfea09e4230c59422e59c6de181 Mon Sep 17 00:00:00 2001
From: Sandy Walsh <sandy.walsh@rackspace.com>
Date: Fri, 27 May 2011 05:01:42 -0700
Subject: fixed docstrings and general tidying

---
 nova/compute/api.py | 39 ++++++++++++++++++++-------------------
 1 file changed, 20 insertions(+), 19 deletions(-)

(limited to 'nova/compute')

diff --git a/nova/compute/api.py b/nova/compute/api.py
index 7f1fe1b5c..3e5105050 100644
--- a/nova/compute/api.py
+++ b/nova/compute/api.py
@@ -88,10 +88,10 @@ class API(base.Base):
                         {"method": "get_network_topic", "args": {'fake': 1}})
 
     def _check_injected_file_quota(self, context, injected_files):
-        """Enforce quota limits on injected files.
+        """
+        Enforce quota limits on injected files.
 
         Raises a QuotaError if any limit is exceeded.
-
         """
         if injected_files is None:
             return
@@ -137,10 +137,10 @@ class API(base.Base):
                availability_zone=None, user_data=None, metadata={},
                injected_files=None,
                admin_password=None):
-        """Create the number and type of instances requested.
+        """
+        Create the number and type of instances requested.
 
         Verifies that quota and other arguments are valid.
-
         """
         if not instance_type:
             instance_type = instance_types.get_default_instance_type()
@@ -293,13 +293,13 @@ class API(base.Base):
             return False
 
     def ensure_default_security_group(self, context):
-        """Ensure that a context has a security group.
+        """
+        Ensure that a context has a security group.
 
         Creates a security group for the security context if it does not
         already exist.
 
         :param context: the security context
-
         """
         try:
             db.security_group_get_by_name(context, context.project_id,
@@ -328,11 +328,11 @@ class API(base.Base):
                       "args": {"security_group_id": security_group.id}})
 
     def trigger_security_group_members_refresh(self, context, group_id):
-        """Called when a security group gains a new or loses a member.
+        """
+        Called when a security group gains a new or loses a member.
 
         Sends an update request to each compute node for whom this is
         relevant.
-
         """
         # First, we get the security group rules that reference this group as
         # the grantee..
@@ -370,7 +370,8 @@ class API(base.Base):
                       "args": {"security_group_id": group_id}})
 
     def update(self, context, instance_id, **kwargs):
-        """Updates the instance in the datastore.
+        """
+        Updates the instance in the datastore.
 
         :param context: The security context
         :param instance_id: ID of the instance to update
@@ -379,7 +380,6 @@ class API(base.Base):
                        updated
 
         :returns: None
-
         """
         rv = self.db.instance_update(context, instance_id, kwargs)
         return dict(rv.iteritems())
@@ -424,22 +424,22 @@ class API(base.Base):
 
     @scheduler_api.reroute_compute("get")
     def routing_get(self, context, instance_id):
-        """A version of get with special routing characteristics.
+        """
+        A version of get with special routing characteristics.
 
         Use this method instead of get() if this is the only operation you
         intend to to. It will route to novaclient.get if the instance is not
         found.
-
         """
         return self.get(context, instance_id)
 
     def get_all(self, context, project_id=None, reservation_id=None,
                 fixed_ip=None):
-        """Get all instances filtered by one of the given parameters.
+        """
+        Get all instances filtered by one of the given parameters.
 
         If there is no filter and the context is an admin, it will retreive
         all instances in the system.
-
         """
         if reservation_id is not None:
             return self.db.instance_get_all_by_reservation(
@@ -463,13 +463,13 @@ class API(base.Base):
 
     def _cast_compute_message(self, method, context, instance_id, host=None,
                               params=None):
-        """Generic handler for RPC casts to compute.
+        """
+        Generic handler for RPC casts to compute.
 
         :param params: Optional dictionary of arguments to be passed to the
                        compute worker
 
         :returns: None
-
         """
         if not params:
             params = {}
@@ -483,7 +483,8 @@ class API(base.Base):
 
     def _call_compute_message(self, method, context, instance_id, host=None,
                               params=None):
-        """Generic handler for RPC calls to compute.
+        """
+        Generic handler for RPC calls to compute.
 
         :param params: Optional dictionary of arguments to be passed to the
                        compute worker
@@ -516,10 +517,10 @@ class API(base.Base):
                                 % instance_id)
 
     def snapshot(self, context, instance_id, name):
-        """Snapshot the given instance.
+        """
+        Snapshot the given instance.
 
         :returns: A dict containing image metadata
-
         """
         properties = {'instance_id': str(instance_id),
                       'user_id': str(context.user_id)}
-- 
cgit