From: Alan Mackenzie <acm@muc.de>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 38205-done@debbugs.gnu.org
Subject: bug#38205: Unhelpful documentation for add-variable-watcher.
Date: Sat, 16 Nov 2019 12:35:57 +0000 [thread overview]
Message-ID: <20191116123557.GA6711@ACM> (raw)
In-Reply-To: <83v9rl336u.fsf@gnu.org>
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 <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.
Thanks!
--
Alan Mackenzie (Nuremberg, Germany).
prev parent reply other threads:[~2019-11-16 12:35 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
2019-11-16 12:35 ` Alan Mackenzie [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20191116123557.GA6711@ACM \
--to=acm@muc.de \
--cc=38205-done@debbugs.gnu.org \
--cc=eliz@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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.