Xen: use epydoc in MigrateInstance docstring
authorGuido Trotter <ultrotter@google.com>
Tue, 20 Jan 2009 18:11:35 +0000 (18:11 +0000)
committerGuido Trotter <ultrotter@google.com>
Tue, 20 Jan 2009 18:11:35 +0000 (18:11 +0000)
Reviewed-by: iustinp

lib/hypervisor/hv_xen.py

index 0aa9560..6da7f1a 100644 (file)
@@ -269,16 +269,16 @@ class XenHypervisor(hv_base.BaseHypervisor):
   def MigrateInstance(self, instance, target, live):
     """Migrate an instance to a target node.
 
-    Arguments:
-      - instance: the name of the instance
-      - target: the ip of the target node
-      - live: whether to do live migration or not
-
-    Returns: none, errors will be signaled by exception.
-
     The migration will not be attempted if the instance is not
     currently running.
 
+    @type instance: string
+    @param instance: instance name
+    @type target: string
+    @param target: ip address of the target node
+    @type live: boolean
+    @param live: perform a live migration
+
     """
     if self.GetInstanceInfo(instance) is None:
       raise errors.HypervisorError("Instance not running, cannot migrate")