unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Glenn Morris <rgm@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 15940@debbugs.gnu.org, Lars Ingebrigtsen <larsi@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	[thread overview]
Message-ID: <bzwqh51i8z.fsf@fencepost.gnu.org> (raw)
In-Reply-To: <83y51mvui3.fsf@gnu.org> (Eli Zaretskii's message of "Sat, 08 Feb 2014 11:11:48 +0200")

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.





  reply	other threads:[~2014-02-08 20:06 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-11-20 22:08 bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables Drew Adams
2014-02-08  3:13 ` Lars Ingebrigtsen
2014-02-08  9:11   ` Eli Zaretskii
2014-02-08 20:06     ` Glenn Morris [this message]
2014-02-09  0:20       ` Glenn Morris
2014-02-08 23:05   ` Drew Adams

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bzwqh51i8z.fsf@fencepost.gnu.org \
    --to=rgm@gnu.org \
    --cc=15940@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=larsi@gnus.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).