GNU bug report logs - #16868
Instrumenting macro for edebug turns it "not documented"

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 16868 in the body.
You can then email your comments to 16868 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Juanma Barranquero <lekktu <at> gmail.com>
To: Bug-Gnu-Emacs <bug-gnu-emacs <at> gnu.org>
Subject: Instrumenting macro for edebug turns it "not documented"
Date: Mon, 24 Feb 2014 18:37:18 +0100

Package: emacs
Severity: minor

Is there any reason that instrumenting a macro for edebug "loses" its
docstring, which does not happen for functions?

emacs -Q
eval the following code:

(defmacro test-macro (&rest body)
  "This is a test macro."
  `(progn ,@body))

C-h f test-macro <RET> => This is a test macro
C-u C-M-x
C-h f test-macro <RET> => Not documented.

I can see that it is nothing new, it already happens in 21.X. But it's puzzling.

Message #8 received at 16868 <at> debbugs.gnu.org (full text, mbox):

From: Glenn Morris <rgm <at> gnu.org>
To: Juanma Barranquero <lekktu <at> gmail.com>
Cc: 16868 <at> debbugs.gnu.org
Subject: Re: bug#16868: Instrumenting macro for edebug turns it "not
 documented"
Date: Tue, 25 Feb 2014 14:37:59 -0500

Is it as simple as this?


*** lisp/emacs-lisp/edebug.el	2014-02-10 01:34:22 +0000
--- lisp/emacs-lisp/edebug.el	2014-02-25 19:35:39 +0000
***************
*** 1936,1946 ****
  	   [&optional stringp]
  	   [&optional ("interactive" interactive)]
  	   def-body))
- ;; FIXME? Isn't this missing the doc-string?  Cf defun.
  (def-edebug-spec defmacro
    ;; FIXME: Improve `declare' so we can Edebug gv-expander and
    ;; gv-setter declarations.
!   (&define name lambda-list [&optional ("declare" &rest sexp)] def-body))
  
  (def-edebug-spec arglist lambda-list)  ;; deprecated - use lambda-list.
  
--- 1936,1946 ----
  	   [&optional stringp]
  	   [&optional ("interactive" interactive)]
  	   def-body))
  (def-edebug-spec defmacro
    ;; FIXME: Improve `declare' so we can Edebug gv-expander and
    ;; gv-setter declarations.
!   (&define name lambda-list [&optional stringp]
!            [&optional ("declare" &rest sexp)] def-body))
  
  (def-edebug-spec arglist lambda-list)  ;; deprecated - use lambda-list.
  

Message #11 received at 16868 <at> debbugs.gnu.org (full text, mbox):

From: Juanma Barranquero <lekktu <at> gmail.com>
To: Glenn Morris <rgm <at> gnu.org>
Cc: 16868 <at> debbugs.gnu.org
Subject: Re: bug#16868: Instrumenting macro for edebug turns it "not
 documented"
Date: Tue, 25 Feb 2014 21:49:39 +0100

On Tue, Feb 25, 2014 at 8:37 PM, Glenn Morris <rgm <at> gnu.org> wrote:

> Is it as simple as this?

Seems so. Thanks!

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.