From: Juanma Barranquero <lekktu@gmail.com>
Date: Mon, 4 Jul 2005 01:22:30 +0000 (+0000)
Subject: (with-timeout): Improve argument/docstring consistency.
X-Git-Tag: emacs-pretest-22.0.90~8447
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=7452fadcb3c10e01070ec0e0e43144934b015f04;p=emacs.git

(with-timeout): Improve argument/docstring consistency.
---

diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el
index 79aad8bd121..d9662f91c7f 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))