From 5972a309f161d3ebe819489187285ad0f1dd43b1 Mon Sep 17 00:00:00 2001 From: Tim Van Baak Date: Sat, 18 Jan 2020 12:19:42 -0800 Subject: [PATCH] Add documentation to custom errors --- amanuensis/errors.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/amanuensis/errors.py b/amanuensis/errors.py index 7f851c5..76b3bd5 100644 --- a/amanuensis/errors.py +++ b/amanuensis/errors.py @@ -3,10 +3,21 @@ class AmanuensisError(Exception): pass class MissingConfigError(AmanuensisError): + """A config file is missing that was expected to be present""" pass class MalformedConfigError(AmanuensisError): + """A config file could not be read and parsed""" pass class ReadOnlyError(AmanuensisError): + """A config was edited in readonly mode""" pass + +class InternalMisuseError(AmanuensisError): + """An internal helper method was called wrongly""" + pass + +class IndexMismatchError(AmanuensisError): + """An id was obtained from an index, but the object doesn't exist""" + pass \ No newline at end of file