Add documentation to custom errors
This commit is contained in:
parent
51b2bfe875
commit
5972a309f1
|
@ -3,10 +3,21 @@ class AmanuensisError(Exception):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
class MissingConfigError(AmanuensisError):
|
class MissingConfigError(AmanuensisError):
|
||||||
|
"""A config file is missing that was expected to be present"""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
class MalformedConfigError(AmanuensisError):
|
class MalformedConfigError(AmanuensisError):
|
||||||
|
"""A config file could not be read and parsed"""
|
||||||
pass
|
pass
|
||||||
|
|
||||||
class ReadOnlyError(AmanuensisError):
|
class ReadOnlyError(AmanuensisError):
|
||||||
|
"""A config was edited in readonly mode"""
|
||||||
pass
|
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
|
Loading…
Reference in New Issue