Re: Poor quality documentation in edebug.el, and recursive documentation.

[Alan Mackenzie]

Hello, Stefan.

On Wed, May 06, 2020 at 14:20:15 -0400, Stefan Monnier wrote:

[ .... ]

> > Now people have explained it, I see that it means "return the value
> > of the slot def-name".  That is explicit and says what is done.  Why
> > can that not be written?

> Sounds fine to me, yes.

> Any objection to the patch below?

Quite the opposite.  :-)  Please commit it.

>         Stefan


> diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el
> index 4408bb58464..237d85b81d3 100644
> --- a/lisp/emacs-lisp/cl-macs.el
> +++ b/lisp/emacs-lisp/cl-macs.el
> @@ -2899,7 +2899,7 @@ cl-defstruct
>             ;; The arg "cl-x" is referenced by name in eg pred-form
>             ;; and pred-check, so changing it is not straightforward.
>             (push `(,defsym ,accessor (cl-x)
> -                       ,(format "Access slot \"%s\" of `%s' struct CL-X.%s"
> +                       ,(format "Return value of the slot \"%s\" of `%s' 
> struct CL-X.%s"
>                                  slot name
>                                  (if doc (concat "\n" doc) ""))
>                         (declare (side-effect-free t))

-- 
Alan Mackenzie (Nuremberg, Germany).