Mercurial > public > m209
view docs/exceptions.rst @ 68:30aa114bb746
Added docs for StdProcedure and exceptions.
author | Brian Neal <bgneal@gmail.com> |
---|---|
date | Sun, 21 Jul 2013 14:03:55 -0500 |
parents | |
children | 854c5d361011 |
line wrap: on
line source
Exceptions ========== The ``m209`` library defines an exception hierarchy, rooted at the ``M209Error`` class. These exceptions are briefly described below. .. class:: m209.M209Error() The base exception in the hierarchy. It inherits from the built in Python ``Exception`` class. .. class:: m209.drum.DrumError() Inherits from :class:`~m209.M209Error`. This is an internal exception, used to report drum related errors. .. class:: m209.key_wheel.KeyWheelError() Inherits from :class:`~m209.M209Error`. This is an internal exception, used to report key wheel related errors. .. class:: m209.keylist.generate.KeyListGenError() Inherits from :class:`~m209.M209Error`. This is public exception, used to report errors during the key list generation process. .. class:: m209.procedure.ProcedureError() Inherits from :class:`~m209.M209Error`. This is public exception, used to report errors during :class:`~m209.procedure.StdProcedure` operations.