bug#38205: Unhelpful documentation for add-variable-watcher.

[Alan Mackenzie]

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).