Return to error.rst CVS log

Up to [ELWIX - Embedded LightWeight unIX -] / gpl / axl / py-axl / doc

Annotation of gpl/axl/py-axl/doc/error.rst, revision 1.1.1.1

1.1       misho       1: :mod:`axl` --- PyAxlError class: error handling and reporting
                      2: ===============================================================
                      3: 
                      4: .. currentmodule:: axl
                      5: 
                      6: 
                      7: =====
                      8: Intro
                      9: =====
                     10: 
                     11: :class:`axl.Error` class is used to report errors found while using
                     12: PyAxl API. The class contains two attributes that contains the integer
                     13: error code and a textual diagnostic with a human readable text.
                     14: 
                     15: ==========
                     16: Module API
                     17: ==========
                     18: 
                     19: .. class:: Error
                     20: 
                     21:    .. attribute:: code
                     22: 
                     23:       (Read only attribute) (Integer) Error code.
                     24: 
                     25:    .. attribute:: msg
                     26: 
                     27:       (Read only attribute) (String) Textual error.
                     28: