From 0bc8432bfe956bb8fa4e624a6850e3d6fa5077a3 Mon Sep 17 00:00:00 2001
From: Guido Trotter <ultrotter@google.com>
Date: Mon, 31 Aug 2009 15:58:05 +0100
Subject: [PATCH] confd/querylib: fix docstrings
They were cut&paste from the first example queries, rather than
documenting the current ones.
Signed-off-by: Guido Trotter <ultrotter@google.com>
Reviewed-by: Michael Hanselmann <hansmi@google.com>
---
lib/confd/querylib.py | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/lib/confd/querylib.py b/lib/confd/querylib.py
index 74ce4589c..af0c32d9b 100644
--- a/lib/confd/querylib.py
+++ b/lib/confd/querylib.py
@@ -70,7 +70,7 @@ class PingQuery(ConfdQuery):
"""
def Exec(self, query):
- """EmptyQuery main execution
+ """PingQuery main execution.
"""
if query is None:
@@ -84,9 +84,9 @@ class PingQuery(ConfdQuery):
class NodeRoleQuery(ConfdQuery):
- """An empty confd query.
+ """A query for the role of a node.
- It will return success on an empty argument, and an error on any other argument.
+ It will return one of CONFD_NODE_ROLE_*, or an error for non-existing nodes.
"""
def Exec(self, query):
@@ -116,13 +116,14 @@ class NodeRoleQuery(ConfdQuery):
class InstanceIpToNodePrimaryIpQuery(ConfdQuery):
- """An empty confd query.
+ """A query for the location of an instance's ip.
- It will return success on an empty argument, and an error on any other argument.
+ It returns the primary ip of the node hosting the instance having the
+ requested ip address, or an error if no such address is known.
"""
def Exec(self, query):
- """EmptyQuery main execution
+ """InstanceIpToNodePrimaryIpQuery main execution.
"""
instance_ip = query
--
GitLab