From: Alan Mackenzie <acm@muc.de>
To: 38205@debbugs.gnu.org
Subject: bug#38205: Unhelpful documentation for add-variable-watcher.
Date: Thu, 14 Nov 2019 07:38:35 +0000 [thread overview]
Message-ID: <20191114073835.GA4935@ACM> (raw)
Hello, Emacs.
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.
. I'm guessing that the first of these applies, but I shouldn't have to
guess. The difference is whether one can get the old value from SYMBOL
or not.
The documentation in the Elisp manual is similarly ambiguous. It uses
the conjunction "whenever".
--
Alan Mackenzie (Nuremberg, Germany).
next reply other threads:[~2019-11-14 7:38 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-14 7:38 Alan Mackenzie [this message]
2019-11-15 9:21 ` bug#38205: Unhelpful documentation for add-variable-watcher Eli Zaretskii
2019-11-16 12:35 ` Alan Mackenzie
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
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191114073835.GA4935@ACM \
--to=acm@muc.de \
--cc=38205@debbugs.gnu.org \
/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 public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).