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

[GNU bug Tracking System]

Your message dated Fri, 15 Nov 2019 11:21:29 +0200
with message-id <address@hidden>
and subject line Re: bug#38205: Unhelpful documentation for 
add-variable-watcher.
has caused the debbugs.gnu.org bug report #38205,
regarding Unhelpful documentation for add-variable-watcher.
to be marked as done.

(If you believe you have received this mail in error, please contact
address@hidden.)


-- 
38205: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=38205
GNU Bug Tracking System
Contact address@hidden with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> Unhelpful documentation for add-variable-watcher.
>
>
>
>
> Date: 
>
> Thu, 14 Nov 2019 07:38:35 +0000
>
>
>
>
> User-agent: 
>
> Mutt/1.10.1 (2018-07-13)
>
>
>
>
> 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).
>
>
>
> --- End Message ---
> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#38205: Unhelpful documentation for add-variable-watcher.
>
>
>
>
> Date: 
>
> Fri, 15 Nov 2019 11:21:29 +0200
>
>
>
>
> > Date: Thu, 14 Nov 2019 07:38:35 +0000
> > From: Alan Mackenzie <address@hidden>
> > 
> > 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.
>
>
> --- End Message ---