Document that OpTestDelay/TestDelay take duration in seconds

Also, fix @rtype and @return elements of utils.TestDelay(), which now
returns a tuple but this wasn't being indicated.

Signed-off-by: Dato Simó <dato@google.com>
Reviewed-by: Helga Velroyen <helgav@google.com>

diff --git a/lib/opcodes.py b/lib/opcodes.py
index e533310..7d67282 100644 (file)
--- a/lib/opcodes.py
+++ b/lib/opcodes.py
@@ -1959,7 +1959,7 @@ class OpTestDelay(OpCode):
   This is used just for debugging and testing.
 
   Parameters:
-    - duration: the time to sleep
+    - duration: the time to sleep, in seconds
     - on_master: if true, sleep on the master
     - on_nodes: list of nodes in which to sleep
 

diff --git a/lib/utils/wrapper.py b/lib/utils/wrapper.py
index 3b6f6f3..7c98c6f 100644 (file)
--- a/lib/utils/wrapper.py
+++ b/lib/utils/wrapper.py
@@ -37,9 +37,10 @@ def TestDelay(duration):
   """Sleep for a fixed amount of time.
 
   @type duration: float
-  @param duration: the sleep duration
-  @rtype: boolean
-  @return: False for negative value, True otherwise
+  @param duration: the sleep duration, in seconds
+  @rtype: (boolean, str)
+  @return: False for negative value, and an accompanying error message;
+      True otherwise (and msg is None)
 
   """
   if duration < 0: