From: Leandro Lucarella <llucarella@integratech.com.ar>
Date: Thu, 27 Sep 2007 16:34:37 +0000 (-0300)
Subject: Add LoopInterruptedError documentation.
X-Git-Url: https://git.llucax.com/software/pymin.git/commitdiff_plain/34ee81ffe3f84f04f50e958551a11cf31b09bd92

Add LoopInterruptedError documentation.
---

diff --git a/eventloop.py b/eventloop.py
index acc370a..932e1b8 100644
--- a/eventloop.py
+++ b/eventloop.py
@@ -12,11 +12,27 @@ from select import POLLIN, POLLPRI, POLLERR
 __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):
+        r"""Initialize the object.
+
+        See the class documentation for more info.
+        """
         self.select_error = select_error
+
     def __repr__(self):
+        r"repr(obj) -> Object representation."
         return 'LoopInterruptedError(select_error=%r)' % self.select_error
+
     def __str__(self):
+        r"str(obj) -> String representation."
         return 'Loop interrupted: %s' % self.select_error
 
 class EventLoop: