From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.devel Subject: Re: Poor quality documentation in edebug.el, and recursive documentation. Date: Fri, 8 May 2020 19:59:08 +0000 Message-ID: <20200508195908.GC6705@ACM> References: <20200505202048.GA15482@ACM> <6674ab3a-9107-d59f-5758-2fd5961cfbcc@gmail.com> <20200506170134.GB5741@ACM> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="41876"; mail-complaints-to="usenet@ciao.gmane.io" Cc: =?iso-8859-1?Q?Cl=E9ment?= Pit-Claudel , emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Fri May 08 21:59:42 2020 Return-path: Envelope-to: ged-emacs-devel@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1jX99q-000AoQ-5B for ged-emacs-devel@m.gmane-mx.org; Fri, 08 May 2020 21:59:42 +0200 Original-Received: from localhost ([::1]:54606 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jX99p-0002St-7T for ged-emacs-devel@m.gmane-mx.org; Fri, 08 May 2020 15:59:41 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:56868) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jX99L-00022I-Uv for emacs-devel@gnu.org; Fri, 08 May 2020 15:59:11 -0400 Original-Received: from colin.muc.de ([193.149.48.1]:36678 helo=mail.muc.de) by eggs.gnu.org with smtp (Exim 4.90_1) (envelope-from ) id 1jX99L-00075a-1Z for emacs-devel@gnu.org; Fri, 08 May 2020 15:59:11 -0400 Original-Received: (qmail 28552 invoked by uid 3782); 8 May 2020 19:59:09 -0000 Original-Received: from acm.muc.de (p4FE1598D.dip0.t-ipconnect.de [79.225.89.141]) by localhost.muc.de (tmda-ofmipd) with ESMTP; Fri, 08 May 2020 21:59:08 +0200 Original-Received: (qmail 6809 invoked by uid 1000); 8 May 2020 19:59:08 -0000 Content-Disposition: inline In-Reply-To: X-Delivery-Agent: TMDA/1.1.12 (Macallan) X-Primary-Address: acm@muc.de Received-SPF: pass client-ip=193.149.48.1; envelope-from=acm@muc.de; helo=mail.muc.de X-detected-operating-system: by eggs.gnu.org: First seen = 2020/05/08 15:53:27 X-ACL-Warn: Detected OS = FreeBSD 9.x or newer [fuzzy] X-Spam_score_int: -18 X-Spam_score: -1.9 X-Spam_bar: - X-Spam_report: (-1.9 / 5.0 requ) BAYES_00=-1.9, SPF_PASS=-0.001 autolearn=_AUTOLEARN X-Spam_action: no action X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.23 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.io gmane.emacs.devel:249322 Archived-At: 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).