From 82f6e37bdd112d223580abdbe788442a6bb22666 Mon Sep 17 00:00:00 2001 From: René 'Necoro' Neumann Date: Fri, 14 Aug 2009 18:53:17 +0200 Subject: Add documentation --- portato/eix/exceptions.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) (limited to 'portato/eix/exceptions.py') diff --git a/portato/eix/exceptions.py b/portato/eix/exceptions.py index fd72dcf..8145af4 100644 --- a/portato/eix/exceptions.py +++ b/portato/eix/exceptions.py @@ -10,20 +10,36 @@ # # Written by René 'Necoro' Neumann +""" +Different exceptions used in the eix module. +""" + from __future__ import absolute_import, with_statement +__docformat__ = "restructuredtext" class EixError (Exception): + """ + The base class for all exceptions of this module. + + :ivar message: The error message + """ message = _("Unknown error.") def __str__ (self): return self.message class EndOfFileException (EixError): + """ + Denotes the unexpected EOF. + """ def __init__ (self, filename): self.message = _("End of file reached though it was not expected: '%s'") % filename class UnsupportedVersionError (EixError): + """ + The version of the cache file found is not supported. + """ def __init__ (self, version): self.message = _("Version '%s' is not supported.") % version -- cgit v1.2.3-70-g09d2