* bug#38205: Unhelpful documentation for add-variable-watcher.
@ 2019-11-14 7:38 Alan Mackenzie
2019-11-15 9:21 ` Eli Zaretskii
0 siblings, 1 reply; 3+ messages in thread
From: Alan Mackenzie @ 2019-11-14 7:38 UTC (permalink / raw)
To: 38205
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).
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#38205: Unhelpful documentation for add-variable-watcher.
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
0 siblings, 1 reply; 3+ messages in thread
From: Eli Zaretskii @ 2019-11-15 9:21 UTC (permalink / raw)
To: Alan Mackenzie; +Cc: 38205-done
> 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.
^ permalink raw reply [flat|nested] 3+ messages in thread
* bug#38205: Unhelpful documentation for add-variable-watcher.
2019-11-15 9:21 ` Eli Zaretskii
@ 2019-11-16 12:35 ` Alan Mackenzie
0 siblings, 0 replies; 3+ messages in thread
From: Alan Mackenzie @ 2019-11-16 12:35 UTC (permalink / raw)
To: Eli Zaretskii; +Cc: 38205-done
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).
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2019-11-16 12:35 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
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).