eldoc hint for dolist is confusing

eldoc hint for dolist is confusing

[Liang Wang]

Eldoc hint for dolist in GNU Emacs 23.0.60 is

    dolist: VAR LIST RESULT BODY...

It's confusing for me.

I like the one in Emacs 22.  It looks like:

    dolist: ((VAR LIST [RESULT]) BODY...)

Is this change intentionally?  Or a bug?

Thanks,
Liang.

Re: eldoc hint for dolist is confusing

[Glenn Morris]

Liang Wang wrote:

> Eldoc hint for dolist in GNU Emacs 23.0.60 is
>
>     dolist: VAR LIST RESULT BODY...
>
> It's confusing for me.
>
> I like the one in Emacs 22.  It looks like:
>
>     dolist: ((VAR LIST [RESULT]) BODY...)
>
> Is this change intentionally?  Or a bug?

It seems to be due to this?

2007-09-26  Juanma Barranquero  <lekktu@gmail.com>

   * emacs-lisp/eldoc.el (eldoc-function-argstring-format):
   Deal with the case that special &keywords are at the
   beginning or end of the argument list.  Also add some (incomplete)
   support for non-standard arglists.

Re: eldoc hint for dolist is confusing

[Juanma Barranquero]

On Sat, Jan 24, 2009 at 01:52, Glenn Morris <rgm@gnu.org> wrote:

> It seems to be due to this?

Yes, sorry.

The problem I was fixing is that, without the patch, having a function

  (defun test (&optional sometimes)
     ...)

eldoc thinks that test has two arguments, `&optional' and `sometimes'.

Please try the attached fix.

    Juanma


Index: lisp/emacs-lisp/eldoc.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/emacs-lisp/eldoc.el,v
retrieving revision 1.56
diff -u -2 -r1.56 eldoc.el
--- lisp/emacs-lisp/eldoc.el	17 Jan 2009 20:01:17 -0000	1.56
+++ lisp/emacs-lisp/eldoc.el	24 Jan 2009 01:34:05 -0000
@@ -492,8 +492,8 @@
 The words \"&rest\", \"&optional\" are returned unchanged."
   (mapconcat (lambda (s)
-	       (if (member s '("&optional" "&rest"))
+	       (if (string-match-p "\\`(?&\\(?:optional\\|rest\\))?\\'" s)
 		   s
 		 (funcall eldoc-argument-case s)))
-	     (split-string argstring "[][ ()]+" t) " "))
+	     (split-string argstring) " "))

 \f