GNU bug report logs - #11040
24.0.94; doc string of `indirect-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 11040 in the body.
You can then email your comments to 11040 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: "Drew Adams" <drew.adams <at> oracle.com>
To: <bug-gnu-emacs <at> gnu.org>
Subject: 24.0.94; doc string of `indirect-variable'
Date: Sun, 18 Mar 2012 09:36:52 -0700

The doc string, unlike (elisp) `Variable Aliases', is not at all clear.
It says nothing about what is meant here by "indirection".  This is
Lisp.  There are several kinds of "indirection" for Lisp variables,
including via values and via properties.
 
The manual makes clear what is meant by talking about "aliases", which
is the kind of indirection this function is about.  Please do similarly
for the doc string.
 
To be even clearer, the doc (in both places, but especially the doc
string, since the manual node already sets the context) should
explicitly mention `defvaralias' when referring to variable aliasing.
 

In GNU Emacs 24.0.94.1 (i386-mingw-nt5.1.2600)
 of 2012-02-26 on MARVIN
Windowing system distributor `Microsoft Corp.', version 5.1.2600
Configured using:
 `configure --with-gcc (4.6) --no-opt --enable-checking --cflags
 -ID:/devel/emacs/libs/libXpm-3.5.8/include
 -ID:/devel/emacs/libs/libXpm-3.5.8/src
 -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include
 -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include
 -ID:/devel/emacs/libs/giflib-4.1.4-1/include
 -ID:/devel/emacs/libs/jpeg-6b-4/include
 -ID:/devel/emacs/libs/tiff-3.8.2-1/include
 -ID:/devel/emacs/libs/gnutls-3.0.9/include'
 

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

From: Chong Yidong <cyd <at> gnu.org>
To: "Drew Adams" <drew.adams <at> oracle.com>
Cc: 11040 <at> debbugs.gnu.org
Subject: Re: bug#11040: 24.0.94; doc string of `indirect-variable'
Date: Wed, 15 Aug 2012 01:06:58 +0800

"Drew Adams" <drew.adams <at> oracle.com> writes:

> The doc string, unlike (elisp) `Variable Aliases', is not at all clear.
> It says nothing about what is meant here by "indirection".  This is
> Lisp.  There are several kinds of "indirection" for Lisp variables,
> including via values and via properties.

Fixed in trunk.

Previous Next

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