From: Eli Zaretskii <eliz@gnu.org>
To: Alan Mackenzie <acm@muc.de>
Cc: 38205-done@debbugs.gnu.org
Subject: bug#38205: Unhelpful documentation for add-variable-watcher.
Date: Fri, 15 Nov 2019 11:21:29 +0200 [thread overview]
Message-ID: <83v9rl336u.fsf@gnu.org> (raw)
In-Reply-To: <20191114073835.GA4935@ACM> (message from Alan Mackenzie on Thu, 14 Nov 2019 07:38:35 +0000)
> Date: Thu, 14 Nov 2019 07:38:35 +0000
> From: Alan Mackenzie <acm@muc.de>
>
> 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.
next prev parent reply other threads:[~2019-11-15 9:21 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-11-14 7:38 bug#38205: Unhelpful documentation for add-variable-watcher Alan Mackenzie
2019-11-15 9:21 ` Eli Zaretskii [this message]
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=83v9rl336u.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=38205-done@debbugs.gnu.org \
--cc=acm@muc.de \
/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).