From 8dca23a36954306bd4c42b4e06328a8d24fac4ce Mon Sep 17 00:00:00 2001
From: Iustin Pop <iustin@google.com>
Date: Mon, 24 Nov 2008 11:01:24 +0000
Subject: [PATCH] Documentation updates for mcpu.py
This is the only change needed to make mcpu epydoc-compliant.
Reviewed-by: ultrotter
---
lib/mcpu.py | 9 ++++-----
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/lib/mcpu.py b/lib/mcpu.py
index 70816a593..9804d2ddf 100644
--- a/lib/mcpu.py
+++ b/lib/mcpu.py
@@ -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]:
--
GitLab