changeset 63994:f44f159ea6de

(with-timeout): Improve argument/docstring consistency.
author Juanma Barranquero <lekktu@gmail.com>
date Mon, 04 Jul 2005 01:22:30 +0000
parents ef9f3b48923d
children 3f647997374d
files lisp/emacs-lisp/timer.el
diffstat 1 files changed, 3 insertions(+), 4 deletions(-) [+]
line wrap: on
line diff
--- a/lisp/emacs-lisp/timer.el	Mon Jul 04 01:13:26 2005 +0000
+++ b/lisp/emacs-lisp/timer.el	Mon Jul 04 01:22:30 2005 +0000
@@ -408,12 +408,11 @@
 (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))