traverseda
/
cpython
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Markup fix; explain what interval timers do; typo fix

This commit is contained in:
Andrew M. Kuchling 2008-04-05 02:47:07 +00:00
parent 9ff4aea24c
commit 1f2af8c6e4
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Doc/library/signal.rst
View File

@ -82,7 +82,7 @@ The variables defined in the :mod:`signal` module are:
.. data:: ITIMER_REAL .. 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 .. 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 :func:`alarm`) and after that every *interval* seconds. The interval
timer specified by *which* can be cleared by setting seconds to zero. 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). The old values are returned as a tuple: (delay, interval).
Attempting to pass an invalid interval timer will cause a 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) .. 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 .. versionadded:: 2.6