From 0a05f95994719713499a6a6874b04313e4f653ed Mon Sep 17 00:00:00 2001
From: Adeodato Simo <dato@google.com>
Date: Mon, 10 Jan 2011 15:05:30 +0000
Subject: [PATCH] Fix docstring for "cmd" in qa_utils.GetSSHCommand

Docstring indicated "cmd" should be a list, when it's expected that
it'll be a string.

Also, converted docstring to current epydoc-style list of function
arguments.

Signed-off-by: Adeodato Simo <dato@google.com>
Reviewed-by: Iustin Pop <iustin@google.com>
---
 qa/qa_utils.py | 10 ++++++----
 1 file changed, 6 insertions(+), 4 deletions(-)

diff --git a/qa/qa_utils.py b/qa/qa_utils.py
index 8c7eec345..110f4a38c 100644
--- a/qa/qa_utils.py
+++ b/qa/qa_utils.py
@@ -146,10 +146,12 @@ def AssertCommand(cmd, fail=False, node=None):
 def GetSSHCommand(node, cmd, strict=True):
   """Builds SSH command to be executed.
 
-  Args:
-  - node: Node the command should run on
-  - cmd: Command to be executed as a list with all parameters
-  - strict: Whether to enable strict host key checking
+  @type node: string
+  @param node: node the command should run on
+  @type cmd: string
+  @param cmd: command to be executed in the node
+  @type strict: boolean
+  @param strict: whether to enable strict host key checking
 
   """
   args = [ 'ssh', '-oEscapeChar=none', '-oBatchMode=yes', '-l', 'root', '-t' ]
-- 
GitLab