Mercurial > public > m209

annotate 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
rev   line source
bgneal@68 1 Exceptions
bgneal@68 2 ==========
bgneal@68 3
bgneal@68 4 The ``m209`` library defines an exception hierarchy, rooted at the
bgneal@68 5 ``M209Error`` class. These exceptions are briefly described below.
bgneal@68 6
bgneal@68 7 .. class:: m209.M209Error()
bgneal@68 8
bgneal@68 9 The base exception in the hierarchy. It inherits from the built in
bgneal@68 10 Python ``Exception`` class.
bgneal@68 11
bgneal@68 12 .. class:: m209.drum.DrumError()
bgneal@68 13
bgneal@68 14 Inherits from :class:`~m209.M209Error`. This is an internal exception, used
bgneal@68 15 to report drum related errors.
bgneal@68 16
bgneal@68 17 .. class:: m209.key_wheel.KeyWheelError()
bgneal@68 18
bgneal@68 19 Inherits from :class:`~m209.M209Error`. This is an internal exception, used
bgneal@68 20 to report key wheel related errors.
bgneal@68 21
bgneal@68 22 .. class:: m209.keylist.generate.KeyListGenError()
bgneal@68 23
bgneal@68 24 Inherits from :class:`~m209.M209Error`. This is public exception, used
bgneal@68 25 to report errors during the key list generation process.
bgneal@68 26
bgneal@68 27 .. class:: m209.procedure.ProcedureError()
bgneal@68 28
bgneal@68 29 Inherits from :class:`~m209.M209Error`. This is public exception, used
bgneal@68 30 to report errors during :class:`~m209.procedure.StdProcedure` operations.