GNU bug report logs - #21709
25.0.50; doc of :variable in `define-minor-mode'

Previous Next

Full log

View this message in rfc822 format

From: Drew Adams <drew.adams <at> oracle.com>
To: 21709 <at> debbugs.gnu.org
Subject: bug#21709: 25.0.50; doc of :variable in `define-minor-mode'
Date: Mon, 19 Oct 2015 08:14:57 -0700 (PDT)

The doc is unclear - both the doc string and (elisp) `Defining Minor
Modes'.  Specifically, the part about PLACE being (GET . SET).

 PLACE can also be of the form (GET . SET), where GET is
 an expression that returns the current state, and SET is
 a function that takes one argument, the new state, and
 sets it.

 PLACE can also be a cons '(GET . SET)', where GET is an expression that
 returns the current state, and SET is a function of one argument (a
 state) that sets it.

Surely the function does not "set" a "state".  It might set the
variable to a new value (but it does not "set" the value).

What is the function argument?  A "state"?  What does that mean?
State of what?  What form does this "state" take?  What does it do?

My guess is that the doc should says something like this:

 The argument is the new variable value, which is assigned to PLACE.

Presumably, "state" should be replaced by "value" everywhere, here.
But that's just a guess.

In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2015-10-09
Bzr revision: af45926d66d303fdc4c2c3ebbc820b4a54d9e4a0
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --host=i686-pc-mingw32 --enable-checking=yes,glyphs'

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.