From 300e545069334c1e952c445700e60c51299976cc Mon Sep 17 00:00:00 2001
From: Michael Hanselmann <hansmi@google.com>
Date: Fri, 12 Oct 2012 12:30:49 +0200
Subject: [PATCH] errors: Document arguments to QueryFilterParseError
Also fix one small mistake in the docstring for QuitGanetiException.
Signed-off-by: Michael Hanselmann <hansmi@google.com>
Reviewed-by: Iustin Pop <iustin@google.com>
---
lib/errors.py | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/lib/errors.py b/lib/errors.py
index ca3050f75..035df4972 100644
--- a/lib/errors.py
+++ b/lib/errors.py
@@ -303,7 +303,7 @@ class QuitGanetiException(Exception):
This is not necessarily an error (and thus not a subclass of
GenericError), but it's an exceptional circumstance and it is thus
- treated. This instance should be instantiated with two values. The
+ treated. This exception should be instantiated with two values. The
first one will specify the return code to the caller, and the second
one will be the returned result (either as an error or as a normal
result). Usually only the leave cluster rpc call should return
@@ -386,6 +386,11 @@ class LuxiError(GenericError):
class QueryFilterParseError(ParseError):
"""Error while parsing query filter.
+ This exception must be instantiated with two values. The first one is a
+ string with an error description, the second one is an instance of a subclass
+ of C{pyparsing.ParseBaseException} (used to display the exact error
+ location).
+
"""
def GetDetails(self):
"""Returns a list of strings with details about the error.
--
GitLab