with-timeout, docstring does not explain LIST arg

with-timeout, docstring does not explain LIST arg

[Lennart Borgman]

The docstring does not explicitly explain the LIST argument.

Re: with-timeout, docstring does not explain LIST arg

[Juanma Barranquero]

On 7/3/05, Lennart Borgman <lennart.borgman.073@student.lu.se> wrote:
> The docstring does not explicitly explain the LIST argument.

The docstring should look like this.

-- 
                    /L/e/k/t/u



Index: lisp/emacs-lisp/timer.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/emacs-lisp/timer.el,v
retrieving revision 1.5
diff -u -2 -r1.5 timer.el
--- lisp/emacs-lisp/timer.el	9 Feb 2005 15:50:40 -0000	1.5
+++ lisp/emacs-lisp/timer.el	3 Jul 2005 15:44:23 -0000
@@ -409,10 +409,9 @@
   "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)))