documentation patch (from Ulrich Neumerkel).

This commit is contained in:
Vitor Santos Costa 2009-05-12 17:06:33 -05:00
parent 13e2febd30
commit bddc09b963

View File

@ -11126,11 +11126,11 @@ terminates, unify @var{Result} with @t{timeout}.
This command is implemented by activating an alarm at procedure This command is implemented by activating an alarm at procedure
entry. If the timer expires before the goal completes, the alarm will entry. If the timer expires before the goal completes, the alarm will
through an exception @var{timeout}. throw an exception @var{timeout}.
One should note that @code{time_out/3} is not reentrant, that is, a goal One should note that @code{time_out/3} is not reentrant, that is, a goal
called from @code{time_out} should never itself call called from @code{time_out} should never itself call
@t{time_out}. Moreover, @code{time_out/3} will deactivate any previous @code{time_out/3}. Moreover, @code{time_out/3} will deactivate any previous
alarms set by @code{alarm/3} and vice-versa, hence only one of these alarms set by @code{alarm/3} and vice-versa, hence only one of these
calls should be used in a program. calls should be used in a program.