From: Iustin Pop <iustin@google.com>
Date: Fri, 27 Feb 2009 13:06:15 +0000 (+0000)
Subject: Fix some epydoc style issues
X-Git-Tag: v2.0.0rc1~10
X-Git-Url: https://code.grnet.gr/git/ganeti-local/commitdiff_plain/5fcc718f5a511fead627c6a5e489b3c3cf5198d1

Fix some epydoc style issues

99% of the epydoc return tags are "@return:", but each of the modified files
had one "@returns:" line. We fix this for consistency.

Reviewed-by: imsnah
---

diff --git a/lib/bootstrap.py b/lib/bootstrap.py
index 3e56154..def4073 100644
--- a/lib/bootstrap.py
+++ b/lib/bootstrap.py
@@ -282,7 +282,7 @@ def InitConfig(version, cluster_config, master_node_config,
   @param cfg_file: configuration file path
 
   @rtype: L{ssconf.SimpleConfigWriter}
-  @returns: initialized config instance
+  @return: initialized config instance
 
   """
   nodes = {
diff --git a/lib/cli.py b/lib/cli.py
index 124f602..6db7cea 100644
--- a/lib/cli.py
+++ b/lib/cli.py
@@ -856,7 +856,7 @@ def FormatTimestamp(ts):
   @param ts: a timeval-type timestamp, a tuple of seconds and microseconds
 
   @rtype: string
-  @returns: a string with the formatted timestamp
+  @return: a string with the formatted timestamp
 
   """
   if not isinstance (ts, (tuple, list)) or len(ts) != 2:
diff --git a/lib/cmdlib.py b/lib/cmdlib.py
index 8dbbbab..bdc25b7 100644
--- a/lib/cmdlib.py
+++ b/lib/cmdlib.py
@@ -1670,7 +1670,7 @@ class LUDiagnoseOS(NoHooksLU):
     @param rlist: a map with node names as keys and OS objects as values
 
     @rtype: dict
-    @returns: a dictionary with osnames as keys and as value another map, with
+    @return: a dictionary with osnames as keys and as value another map, with
         nodes as keys and list of OS objects as values, eg::
 
           {"debian-etch": {"node1": [<object>,...],
diff --git a/lib/config.py b/lib/config.py
index e41014f..ee305d6 100644
--- a/lib/config.py
+++ b/lib/config.py
@@ -827,7 +827,7 @@ class ConfigWriter:
     """Get the configuration of all instances.
 
     @rtype: dict
-    @returns: dict of (instance, instance_info), where instance_info is what
+    @return: dict of (instance, instance_info), where instance_info is what
               would GetInstanceInfo return for the node
 
     """
diff --git a/lib/http/client.py b/lib/http/client.py
index 2c62356..776fade 100644
--- a/lib/http/client.py
+++ b/lib/http/client.py
@@ -368,7 +368,7 @@ class HttpClientManager(object):
     @type requests: List of HttpClientRequest instances
     @param requests: The requests to execute
     @rtype: List of HttpClientRequest instances
-    @returns: The list of requests passed in
+    @return: The list of requests passed in
 
     """
     # _HttpClientPendingRequest is used for internal thread synchronization
diff --git a/lib/rapi/rlib2.py b/lib/rapi/rlib2.py
index 587b736..9e617bf 100644
--- a/lib/rapi/rlib2.py
+++ b/lib/rapi/rlib2.py
@@ -322,7 +322,7 @@ class R_2_instances(baserlib.R_Generic):
         ...
       ]
 
-    @returns: a dictionary with 'name' and 'uri' keys for each of them.
+    @return: a dictionary with 'name' and 'uri' keys for each of them.
 
     """
     client = luxi.Client()
@@ -340,7 +340,7 @@ class R_2_instances(baserlib.R_Generic):
   def POST(self):
     """Create an instance.
 
-    @returns: a job id
+    @return: a job id
 
     """
     if not isinstance(self.req.request_body, dict):
diff --git a/lib/rpc.py b/lib/rpc.py
index a9669fe..70dd312 100644
--- a/lib/rpc.py
+++ b/lib/rpc.py
@@ -217,7 +217,7 @@ class Client:
     """Call nodes and return results.
 
     @rtype: list
-    @returns: List of RPC results
+    @return: List of RPC results
 
     """
     assert _http_manager, "RPC module not intialized"
diff --git a/lib/utils.py b/lib/utils.py
index 6d2552f..5aee828 100644
--- a/lib/utils.py
+++ b/lib/utils.py
@@ -1446,7 +1446,7 @@ def Daemonize(logfile):
   @type logfile: str
   @param logfile: the logfile to which we should redirect stdout/stderr
   @rtype: int
-  @returns: the value zero
+  @return: the value zero
 
   """
   UMASK = 077