Add LoopInterruptedError documentation.

[software/pymin.git] / eventloop.py

diff --git a/eventloop.py b/eventloop.py
index acc370ab03b439730d3eb242d50d6985dc13b349..932e1b802d3709f82364f977a30ea9fe741d665f 100644 (file)
--- a/eventloop.py
+++ b/eventloop.py
@@ -12,11 +12,27 @@ from select import POLLIN, POLLPRI, POLLERR
 __ALL__ = ('EventLoop')
 
 class LoopInterruptedError(RuntimeError):
 __ALL__ = ('EventLoop')
 
 class LoopInterruptedError(RuntimeError):

+    r"""
+    LoopInterruptedError(select_error) -> LoopInterruptedError instance.
+
+    This class is raised when the event loop is interrupted in an unexpected
+    way. It wraps a select error, which can be accessed using the 'select_error'
+    attribute.
+    """
+

     def __init__(self, select_error):
     def __init__(self, select_error):

+        r"""Initialize the object.
+
+        See the class documentation for more info.
+        """

         self.select_error = select_error
         self.select_error = select_error

+

     def __repr__(self):
     def __repr__(self):

+        r"repr(obj) -> Object representation."

         return 'LoopInterruptedError(select_error=%r)' % self.select_error
         return 'LoopInterruptedError(select_error=%r)' % self.select_error

+

     def __str__(self):
     def __str__(self):

+        r"str(obj) -> String representation."

         return 'Loop interrupted: %s' % self.select_error
 
 class EventLoop:
         return 'Loop interrupted: %s' % self.select_error
 
 class EventLoop: