]> granicus.if.org Git - python/commitdiff
Markup fix; explain what interval timers do; typo fix
authorAndrew M. Kuchling <amk@amk.ca>
Sat, 5 Apr 2008 02:47:07 +0000 (02:47 +0000)
committerAndrew M. Kuchling <amk@amk.ca>
Sat, 5 Apr 2008 02:47:07 +0000 (02:47 +0000)
Doc/library/signal.rst

index 9274113ddeae39579cf712510f8391b2a985da4a..9843ff65cfd0a8c86dbac95e131e7fadad263fe4 100644 (file)
@@ -82,7 +82,7 @@ The variables defined in the :mod:`signal` module are:
 
 .. data:: ITIMER_REAL    
 
-   Decrements interval timer in real time, and delivers SIGALRM upon expiration.
+   Decrements interval timer in real time, and delivers :const:`SIGALRM` upon expiration.
 
 
 .. data:: ITIMER_VIRTUAL 
@@ -149,6 +149,12 @@ The :mod:`signal` module defines the following functions:
    :func:`alarm`) and after that every *interval* seconds. The interval
    timer specified by *which* can be cleared by setting seconds to zero.
 
+   When an interval timer fires, a signal is sent to the process.
+   The signal sent is dependent on the timer being used; 
+   :const:`signal.ITIMER_REAL` will deliver :const:`SIGALRM`, 
+   :const:`signal.ITIMER_VIRTUAL` sends :const:`SIGVTALRM`,
+   and :const:`signal.ITIMER_PROF` will deliver :const:`SIGPROF`.
+
    The old values are returned as a tuple: (delay, interval).
 
    Attempting to pass an invalid interval timer will cause a 
@@ -159,7 +165,7 @@ The :mod:`signal` module defines the following functions:
 
 .. function:: getitimer(which)
 
-   Returns current value of a given interval timer especified by *which*.
+   Returns current value of a given interval timer specified by *which*.
 
    .. versionadded:: 2.6