From: Alan Mackenzie <acm@muc.de>
To: Stefan Monnier <monnier@iro.umontreal.ca>
Cc: "Clément Pit-Claudel" <cpitclaudel@gmail.com>, emacs-devel@gnu.org
Subject: Re: Poor quality documentation in edebug.el, and recursive documentation.
Date: Fri, 8 May 2020 19:59:08 +0000 [thread overview]
Message-ID: <20200508195908.GC6705@ACM> (raw)
In-Reply-To: <jwv4kstrkxy.fsf-monnier+emacs@gnu.org>
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).
next prev parent reply other threads:[~2020-05-08 19:59 UTC|newest]
Thread overview: 22+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-05 20:20 Poor quality documentation in edebug.el, and recursive documentation Alan Mackenzie
2020-05-05 20:39 ` Drew Adams
2020-05-05 21:11 ` Clément Pit-Claudel
2020-05-06 17:01 ` Alan Mackenzie
2020-05-06 18:20 ` Stefan Monnier
2020-05-06 18:34 ` Eli Zaretskii
2020-05-08 19:59 ` Alan Mackenzie [this message]
2020-05-09 5:53 ` Eli Zaretskii
2020-05-09 13:47 ` Stefan Monnier
2020-05-09 13:53 ` Eli Zaretskii
2020-05-09 14:56 ` Alan Mackenzie
2020-05-09 15:06 ` tomas
2020-05-09 15:12 ` Andreas Schwab
2020-05-09 15:11 ` Eli Zaretskii
2020-05-06 18:26 ` Stefan Monnier
2020-05-05 22:18 ` Stefan Monnier
2020-05-08 19:53 ` Alan Mackenzie
2020-05-08 20:24 ` Stefan Monnier
2020-05-12 6:33 ` Madhu
2020-05-12 7:42 ` Eli Zaretskii
2020-05-12 14:04 ` cl-generic misdesign (was: Poor quality documentation in edebug.el, and recursive documentation) Stefan Monnier
2020-05-14 5:03 ` Richard Stallman
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200508195908.GC6705@ACM \
--to=acm@muc.de \
--cc=cpitclaudel@gmail.com \
--cc=emacs-devel@gnu.org \
--cc=monnier@iro.umontreal.ca \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.