GNU bug report logs - #15940
24.3.50; doc string of `lwarn' refers to undefined variables

Previous Next

Package: emacs;

Reported by: Drew Adams <drew.adams <at> oracle.com>

Date: Wed, 20 Nov 2013 22:10:02 UTC

Severity: minor

Found in version 24.3.50

Fixed in version 24.4

Done: Glenn Morris <rgm <at> gnu.org>

Bug is archived. No further changes may be made.

Full log

View this message in rfc822 format

From: Glenn Morris <rgm <at> gnu.org>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 15940 <at> debbugs.gnu.org, Lars Ingebrigtsen <larsi <at> gnus.org>
Subject: bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables
Date: Sat, 08 Feb 2014 15:06:52 -0500

Eli Zaretskii wrote:

>> Would it make sense for the help system to always load the package an
>> autoloaded function is defined in?  Especially if the doc string refers
>> to other `...' items?
>
> Why not simply auto-load those variables, especially if the doc string
> refers to them?

Because this is a general problem that comes up again and again,
and papering over it with manual autoloads every time seems like bad
practice.

A change was added for this in 24.3:

    *** `C-h f' (`describe-function') can now perform autoloading.
    When this command is called for an autoloaded function whose docstring
    contains a key substitution construct, that function's library is
    automatically loaded, so that the documentation can be shown
    correctly.  To disable this, set `help-enable-auto-load' to nil.

It needs to be generalized somehow.

I'm pretty sure this has been discussed multiple times in the past,
so there's probably an idea/implementation out there somewhere in the
archives.
This bug report was last modified 11 years and 107 days ago.

Previous Next

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