From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#38205: Unhelpful documentation for add-variable-watcher. Date: Fri, 15 Nov 2019 11:21:29 +0200 Message-ID: <83v9rl336u.fsf@gnu.org> References: <20191114073835.GA4935@ACM> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="135620"; mail-complaints-to="usenet@blaine.gmane.org" Cc: 38205-done@debbugs.gnu.org To: Alan Mackenzie Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Nov 15 10:22:17 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 1iVXo0-000Z2w-Kn for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Nov 2019 10:22:16 +0100 Original-Received: from localhost ([::1]:36932 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVXnu-0002kt-BK for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Nov 2019 04:22:10 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:49313) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iVXno-0002gj-2p for bug-gnu-emacs@gnu.org; Fri, 15 Nov 2019 04:22:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iVXnn-0001oF-4M for bug-gnu-emacs@gnu.org; Fri, 15 Nov 2019 04:22:04 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]:55074) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iVXnn-0001nz-1x for bug-gnu-emacs@gnu.org; Fri, 15 Nov 2019 04:22:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iVXnm-0001Ko-KN for bug-gnu-emacs@gnu.org; Fri, 15 Nov 2019 04:22:02 -0500 Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-To: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Nov 2019 09:22:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: cc-closed 38205 X-GNU-PR-Package: emacs Mail-Followup-To: 38205@debbugs.gnu.org, eliz@gnu.org, acm@muc.de Original-Received: via spool by 38205-done@debbugs.gnu.org id=D38205.15738097115106 (code D ref 38205); Fri, 15 Nov 2019 09:22:02 +0000 Original-Received: (at 38205-done) by debbugs.gnu.org; 15 Nov 2019 09:21:51 +0000 Original-Received: from localhost ([127.0.0.1]:35661 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iVXnb-0001KI-6G for submit@debbugs.gnu.org; Fri, 15 Nov 2019 04:21:51 -0500 Original-Received: from eggs.gnu.org ([209.51.188.92]:40160) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iVXnZ-0001K5-8i for 38205-done@debbugs.gnu.org; Fri, 15 Nov 2019 04:21:49 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:41674) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1iVXnT-0001hy-S4; Fri, 15 Nov 2019 04:21:43 -0500 Original-Received: from [176.228.60.248] (port=3959 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1iVXnT-0001vn-E9; Fri, 15 Nov 2019 04:21:43 -0500 In-reply-to: <20191114073835.GA4935@ACM> (message from Alan Mackenzie on Thu, 14 Nov 2019 07:38:35 +0000) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:171655 Archived-At: > 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.