Trac #15743: Document cancel_alarm() in alarm()

URL: http://trac.sagemath.org/15743 Reported by: jdemeyer Ticket author(s): Jeroen Demeyer Reviewer(s): Marc Mezzarobba
sagemath · Feb 4, 2014 · 3861c7b · 3861c7b
2 parents 494c751 + f13e110
commit 3861c7b
Showing 1 changed file with 3 additions and 1 deletion.
diff --git 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::