From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.ciao.gmane.io!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.devel Subject: Re: Poor quality documentation in edebug.el, and recursive documentation. Date: Sat, 09 May 2020 16:53:09 +0300 Message-ID: <837dxlfc56.fsf@gnu.org> References: <20200505202048.GA15482@ACM> <6674ab3a-9107-d59f-5758-2fd5961cfbcc@gmail.com> <20200506170134.GB5741@ACM> <20200508195908.GC6705@ACM> <83o8qxhcxh.fsf@gnu.org> Injection-Info: ciao.gmane.io; posting-host="ciao.gmane.io:159.69.161.202"; logging-data="86657"; mail-complaints-to="usenet@ciao.gmane.io" Cc: acm@muc.de, cpitclaudel@gmail.com, emacs-devel@gnu.org To: Stefan Monnier Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane-mx.org@gnu.org Sat May 09 15:54:01 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 1jXPvU-000MQ1-3X for ged-emacs-devel@m.gmane-mx.org; Sat, 09 May 2020 15:54:00 +0200 Original-Received: from localhost ([::1]:38354 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jXPvS-0004oh-M8 for ged-emacs-devel@m.gmane-mx.org; Sat, 09 May 2020 09:53:58 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:52236) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1jXPup-0003zz-9N for emacs-devel@gnu.org; Sat, 09 May 2020 09:53:19 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:52332) by eggs.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1jXPuo-00081z-W4; Sat, 09 May 2020 09:53:19 -0400 Original-Received: from [176.228.60.248] (port=4135 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1jXPuo-0001P0-FC; Sat, 09 May 2020 09:53:18 -0400 In-Reply-To: (message from Stefan Monnier on Sat, 09 May 2020 09:47:03 -0400) 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:249436 Archived-At: > From: Stefan Monnier > Cc: Alan Mackenzie , cpitclaudel@gmail.com, emacs-devel@gnu.org > Date: Sat, 09 May 2020 09:47:03 -0400 > > > Once again: "Return value" doesn't sound right to me, since it implies > > read-only access to the value, something that AFAIU is inaccurate. It > > actually returns a settable "place", doesn't it? > > AFAIK the official name for that in OO parlance is an "accessor". > Which is why I used the verb "Access". That's okay, but the patch in question proposes to replace "Access" with "Return value of", and I think this will make the documentation less accurate than the original. Or am I missing something?