all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* 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

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