Documentation updates for mcpu.py
authorIustin Pop <iustin@google.com>
Mon, 24 Nov 2008 11:01:24 +0000 (11:01 +0000)
committerIustin Pop <iustin@google.com>
Mon, 24 Nov 2008 11:01:24 +0000 (11:01 +0000)
This is the only change needed to make mcpu epydoc-compliant.

Reviewed-by: ultrotter

lib/mcpu.py

index 70816a5..9804d2d 100644 (file)
@@ -317,11 +317,10 @@ class HooksMaster(object):
 
     This is the main function of the HookMaster.
 
-    Args:
-      phase: the hooks phase to run
-
-    Returns:
-      the result of the hooks multi-node rpc call
+    @param phase: one of L{constants.HOOKS_PHASE_POST} or
+        L{constants.HOOKS_PHASE_PRE}; it denotes the hooks phase
+    @return: the processed results of the hooks multi-node rpc call
+    @raise errors.HooksFailure: on communication failure to the nodes
 
     """
     if not self.node_list[phase]: