From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Alan Mackenzie Newsgroups: gmane.emacs.bugs Subject: bug#38205: Unhelpful documentation for add-variable-watcher. Date: Sat, 16 Nov 2019 12:35:57 +0000 Message-ID: <20191116123557.GA6711@ACM> References: <20191114073835.GA4935@ACM> <83v9rl336u.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="93357"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Mutt/1.10.1 (2018-07-13) Cc: 38205-done@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Nov 16 13:37:14 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iVxKE-000OCD-BR for geb-bug-gnu-emacs@m.gmane.org; Sat, 16 Nov 2019 13:37:14 +0100 Original-Received: from localhost ([::1]:47638 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVxKD-0007FI-7y for geb-bug-gnu-emacs@m.gmane.org; Sat, 16 Nov 2019 07:37:13 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:36210) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVxK4-0007F7-T5 for bug-gnu-emacs@gnu.org; Sat, 16 Nov 2019 07:37:05 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iVxK3-00055i-3T for bug-gnu-emacs@gnu.org; Sat, 16 Nov 2019 07:37:04 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:57233) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iVxK2-00055W-G7 for bug-gnu-emacs@gnu.org; Sat, 16 Nov 2019 07:37:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iVxK2-0001Wj-BN for bug-gnu-emacs@gnu.org; Sat, 16 Nov 2019 07:37:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Alan Mackenzie Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 16 Nov 2019 12:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 38205 X-GNU-PR-Package: emacs Original-Received: via spool by 38205-done@debbugs.gnu.org id=D38205.15739077625797 (code D ref 38205); Sat, 16 Nov 2019 12:37:02 +0000 Original-Received: (at 38205-done) by debbugs.gnu.org; 16 Nov 2019 12:36:02 +0000 Original-Received: from localhost ([127.0.0.1]:37821 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iVxJ4-0001VG-3P for submit@debbugs.gnu.org; Sat, 16 Nov 2019 07:36:02 -0500 Original-Received: from colin.muc.de ([193.149.48.1]:34966 helo=mail.muc.de) by debbugs.gnu.org with smtp (Exim 4.84_2) (envelope-from ) id 1iVxJ2-0001Ut-2Z for 38205-done@debbugs.gnu.org; Sat, 16 Nov 2019 07:36:00 -0500 Original-Received: (qmail 71748 invoked by uid 3782); 16 Nov 2019 12:35:58 -0000 Original-Received: from acm.muc.de (p2E5D55F4.dip0.t-ipconnect.de [46.93.85.244]) by colin.muc.de (tmda-ofmipd) with ESMTP; Sat, 16 Nov 2019 13:35:57 +0100 Original-Received: (qmail 6721 invoked by uid 1000); 16 Nov 2019 12:35:57 -0000 Content-Disposition: inline In-Reply-To: <83v9rl336u.fsf@gnu.org> X-Delivery-Agent: TMDA/1.1.12 (Macallan) X-Primary-Address: acm@muc.de X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:171721 Archived-At: Hello, Eli. On Fri, Nov 15, 2019 at 11:21:29 +0200, Eli Zaretskii wrote: > > Date: Thu, 14 Nov 2019 07:38:35 +0000 > > From: Alan Mackenzie > > The doc string for add-variable-watcher wrongly states: > > Cause WATCH-FUNCTION to be called when SYMBOL is set. > > . Correct would be either > > Cause WATCH-FUNCTION to be called just before SYMBOL is set. > > or > > Cause WATCH-FUNCTION to be called just after SYMBOL is set. > Well, the doc string goes on to say > NEWVAL is the value it will be changed to. > ^^^^^^^ > which is a clear hint to what actually happens. But I made this even > more clear in the doc string, thanks. > > The documentation in the Elisp manual is similarly ambiguous. It uses > > the conjunction "whenever". > Fixed that as well. Thanks! -- Alan Mackenzie (Nuremberg, Germany).