errors: Document arguments to QueryFilterParseError
authorMichael Hanselmann <hansmi@google.com>
Fri, 12 Oct 2012 10:30:49 +0000 (12:30 +0200)
committerMichael Hanselmann <hansmi@google.com>
Fri, 12 Oct 2012 10:37:43 +0000 (12:37 +0200)
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

index ca3050f..035df49 100644 (file)
@@ -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.