aboutsummaryrefslogtreecommitdiffstats
path: root/lisp/emacs-lisp/timer.el
diff options
context:
space:
mode:
authorJuanma Barranquero <[email protected]>2005-07-04 01:22:30 +0000
committerJuanma Barranquero <[email protected]>2005-07-04 01:22:30 +0000
commit7452fadcb3c10e01070ec0e0e43144934b015f04 (patch)
tree38054e97a8d6c9a3f601dab271e351cebbda42f6 /lisp/emacs-lisp/timer.el
parent9a6f3ca53295806007d2b61c165cec6e68be5320 (diff)
(with-timeout): Improve argument/docstring consistency.
Diffstat (limited to 'lisp/emacs-lisp/timer.el')
-rw-r--r--lisp/emacs-lisp/timer.el7
1 files changed, 3 insertions, 4 deletions
diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el
index 79aad8bd12..d9662f91c7 100644
--- a/lisp/emacs-lisp/timer.el
+++ b/lisp/emacs-lisp/timer.el
@@ -408,12 +408,11 @@ This function returns a timer object which you can use in `cancel-timer'."
(defmacro with-timeout (list &rest body)
"Run BODY, but if it doesn't finish in SECONDS seconds, give up.
If we give up, we run the TIMEOUT-FORMS and return the value of the last one.
-The call should look like:
- (with-timeout (SECONDS TIMEOUT-FORMS...) BODY...)
The timeout is checked whenever Emacs waits for some kind of external
-event \(such as keyboard input, input from subprocesses, or a certain time);
+event (such as keyboard input, input from subprocesses, or a certain time);
if the program loops without waiting in any way, the timeout will not
-be detected."
+be detected.
+\n(fn (SECONDS TIMEOUT-FORMS...) BODY)"
(let ((seconds (car list))
(timeout-forms (cdr list)))
`(let ((with-timeout-tag (cons nil nil))