bug#16868: Instrumenting macro for edebug turns it "not documented"

bug#16868: Instrumenting macro for edebug turns it "not documented"

[Juanma Barranquero]

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.

bug#16868: Instrumenting macro for edebug turns it "not documented"

[Glenn Morris]

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.
  

bug#16868: Instrumenting macro for edebug turns it "not documented"

[Juanma Barranquero]

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

> Is it as simple as this?

Seems so. Thanks!