*.pyx: Add some rather laconic docstrings.

[mLib-python] / sel-timer.pyx

diff --git a/sel-timer.pyx b/sel-timer.pyx
index ba59a7c..ebdd433 100644 (file)
--- a/sel-timer.pyx
+++ b/sel-timer.pyx
@@ -32,6 +32,11 @@ cdef void _floattotv(timeval *tv, double t):
   tv.tv_usec = <int>(us * 1000000)
 
 cdef class SelTimer:
+  """
+  SelTimer(WHEN, [timerproc = None])
+
+  Arrange to perform some action at time WHEN.
+  """
   cdef sel_timer t
   cdef int _activep
   cdef readonly double time
@@ -47,9 +52,11 @@ cdef class SelTimer:
     if me._activep:
       sel_rmtimer(&me.t)
   property activep:
+    """ST.activep -> BOOL: is the timer active?"""
     def __get__(me):
       return _tobool(me._activep)
   property timerproc:
+    """ST.timerproc -> FUNC: call FUNC() when the timer pops"""
     def __get__(me):
       return me._timer
     def __set__(me, proc):
@@ -57,6 +64,7 @@ cdef class SelTimer:
     def __del__(me):
       me._timer = None
   def kill(me):
+    """ST.kill(): deactivate timer permanently"""
     if not me._activep:
       raise ValueError, 'already dead'
     sel_rmtimer(&me.t)
@@ -66,8 +74,10 @@ cdef class SelTimer:
     me._activep = 0
     me.dead()
   def dead(me):
+    """ST.dead(): called when timer is deactivated"""
     pass
   def timer(me, now):
+    """ST.timer(NOW): called when the timer pops"""
     return _maybecall(me._timer, ())
 
 cdef void _timerfunc(timeval *now, void *arg):