From f13e1103442a61b0db93a82c523c0cd6d33305a8 Mon Sep 17 00:00:00 2001 From: Jeroen Demeyer Date: Mon, 27 Jan 2014 15:05:30 +0100 Subject: [PATCH] Document cancel_alarm() in alarm() --- src/sage/misc/misc.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/sage/misc/misc.py b/src/sage/misc/misc.py index 680047bfc66..ef71233dc2a 100644 --- a/src/sage/misc/misc.py +++ b/src/sage/misc/misc.py @@ -1935,6 +1935,8 @@ def alarm(seconds): seconds. This is useful for automatically interrupting long computations and can be trapped using exception handling. + Use :func:`cancel_alarm` to cancel a previously scheduled alarm. + INPUT: - ``seconds`` -- positive number, may be floating point @@ -1956,7 +1958,7 @@ def alarm(seconds): def cancel_alarm(): """ - Cancel a previously scheduled alarm (if any). + Cancel a previously scheduled alarm (if any) set by :func:`alarm`. EXAMPLES::