GNU bug report logs - #7465
doc of transient-mark-mode variable

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 7465 in the body.
You can then email your comments to 7465 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Stephen Berman <stephen.berman <at> gmx.net>
To: bug-gnu-emacs <at> gnu.org
Subject: 24.0.50; transient-mark-mode customization UI is confusing
Date: Mon, 22 Nov 2010 16:21:41 +0100

1. emacs -Q
2. M-x customize-option RET transient-mark-mode RET
=>
The complete text of the doc string is displayed, as usual, but here it
is confusing, because the values `lambda' and `(only . OLDVAL)' cannot
be entered, since only toggling on-off is allowed.  As noted in the
Elisp manual, these values are intended for Lisp programs, so they
should not be mentioned in the Custom interface, which is concerned with
user settings.

In GNU Emacs 24.0.50.1 (i686-pc-linux-gnu, GTK+ Version 2.18.6)
 of 2010-11-22 on escher
Windowing system distributor `The X.Org Foundation', version 11.0.10605000
configured using `configure  '--without-toolkit-scroll-bars''

Message #8 received at 7465 <at> debbugs.gnu.org (full text, mbox):

From: "Drew Adams" <drew.adams <at> oracle.com>
To: "'Stephen Berman'" <stephen.berman <at> gmx.net>, <7465 <at> debbugs.gnu.org>
Subject: RE: bug#7465: 24.0.50;
	transient-mark-mode customization UI is confusing
Date: Mon, 22 Nov 2010 08:15:00 -0800

> The complete text of the doc string is displayed, as usual, 
> but here it is confusing, because the values `lambda' and
> `(only . OLDVAL)' cannot be entered, since only toggling
> on-off is allowed.  As noted in the Elisp manual, these
> values are intended for Lisp programs, so they should not
> be mentioned in the Custom interface, which is concerned with
> user settings.

Users, even users of Customize, can also use Emacs Lisp.  The complete doc
string should always be available in Customize, and the Lisp interface should be
described in the doc string (not just the Customize interface).

However, you have a point in that the Lisp description is not identified as such
here, so this text can indeed be confusing to users.  The correct fix is to
introduce the description of the Lisp values by saying that these are the values
used in Lisp code.

Also, the text should not say that "non-nil _also_ enables highlighting...", for
this highlighting is a big part of what t-m mode is all about.  Please remove
"also" here.

Message #11 received at 7465 <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: Stephen Berman <stephen.berman <at> gmx.net>
Cc: 7465 <at> debbugs.gnu.org
Subject: Re: bug#7465: 24.0.50;
	transient-mark-mode customization UI is confusing
Date: Sat, 04 Dec 2010 16:15:39 -0500

Stephen Berman <stephen.berman <at> gmx.net> writes:

> The complete text of the doc string is displayed, as usual, but here it
> is confusing, because the values `lambda' and `(only . OLDVAL)' cannot
> be entered, since only toggling on-off is allowed.  As noted in the
> Elisp manual, these values are intended for Lisp programs, so they
> should not be mentioned in the Custom interface, which is concerned with
> user settings.

I noted explicitly in the docstring that these values are meant for
Lisp.  Thanks.

Previous Next

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