Mercurial > public > m209

comparison docs/exceptions.rst @ 68:30aa114bb746

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added docs for StdProcedure and exceptions.
author Brian Neal <bgneal@gmail.com>
date Sun, 21 Jul 2013 14:03:55 -0500
parents
children 854c5d361011
comparison
equal deleted inserted replaced
67:a2647b9fe107 68:30aa114bb746
1 Exceptions
2 ==========
3
4 The ``m209`` library defines an exception hierarchy, rooted at the
5 ``M209Error`` class. These exceptions are briefly described below.
6
7 .. class:: m209.M209Error()
8
9 The base exception in the hierarchy. It inherits from the built in
10 Python ``Exception`` class.
11
12 .. class:: m209.drum.DrumError()
13
14 Inherits from :class:`~m209.M209Error`. This is an internal exception, used
15 to report drum related errors.
16
17 .. class:: m209.key_wheel.KeyWheelError()
18
19 Inherits from :class:`~m209.M209Error`. This is an internal exception, used
20 to report key wheel related errors.
21
22 .. class:: m209.keylist.generate.KeyListGenError()
23
24 Inherits from :class:`~m209.M209Error`. This is public exception, used
25 to report errors during the key list generation process.
26
27 .. class:: m209.procedure.ProcedureError()
28
29 Inherits from :class:`~m209.M209Error`. This is public exception, used
30 to report errors during :class:`~m209.procedure.StdProcedure` operations.