unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables
@ 2013-11-20 22:08 Drew Adams
  2014-02-08  3:13 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 6+ messages in thread
From: Drew Adams @ 2013-11-20 22:08 UTC (permalink / raw)
  To: 15940


emacs -Q

C-h f lwarn

The doc string says:

"(but see `warning-minimum-level' and `warning-minimum-log-level')"

That's impossible, before warning.el has been loaded - the variables are
undefined.



In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-11-12 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking 'CFLAGS=-O0 -g3' CPPFLAGS=-DGLYPH_DEBUG=1'





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables
  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 23:05   ` Drew Adams
  0 siblings, 2 replies; 6+ messages in thread
From: Lars Ingebrigtsen @ 2014-02-08  3:13 UTC (permalink / raw)
  To: Drew Adams; +Cc: 15940

Drew Adams <drew.adams@oracle.com> writes:

> C-h f lwarn
>
> The doc string says:
>
> "(but see `warning-minimum-level' and `warning-minimum-log-level')"
>
> That's impossible, before warning.el has been loaded - the variables are
> undefined.

Yeah, it's unfortunate that autoloaded functions can't really refer to
other variables from its "home package" in the help system.

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?

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables
  2014-02-08  3:13 ` Lars Ingebrigtsen
@ 2014-02-08  9:11   ` Eli Zaretskii
  2014-02-08 20:06     ` Glenn Morris
  2014-02-08 23:05   ` Drew Adams
  1 sibling, 1 reply; 6+ messages in thread
From: Eli Zaretskii @ 2014-02-08  9:11 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 15940

> From: Lars Ingebrigtsen <larsi@gnus.org>
> Date: Fri, 07 Feb 2014 19:13:29 -0800
> Cc: 15940@debbugs.gnu.org
> 
> Drew Adams <drew.adams@oracle.com> writes:
> 
> > C-h f lwarn
> >
> > The doc string says:
> >
> > "(but see `warning-minimum-level' and `warning-minimum-log-level')"
> >
> > That's impossible, before warning.el has been loaded - the variables are
> > undefined.
> 
> Yeah, it's unfortunate that autoloaded functions can't really refer to
> other variables from its "home package" in the help system.
> 
> 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?





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables
  2014-02-08  9:11   ` Eli Zaretskii
@ 2014-02-08 20:06     ` Glenn Morris
  2014-02-09  0:20       ` Glenn Morris
  0 siblings, 1 reply; 6+ messages in thread
From: Glenn Morris @ 2014-02-08 20:06 UTC (permalink / raw)
  To: Eli Zaretskii; +Cc: 15940, Lars Ingebrigtsen

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.





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables
  2014-02-08  3:13 ` Lars Ingebrigtsen
  2014-02-08  9:11   ` Eli Zaretskii
@ 2014-02-08 23:05   ` Drew Adams
  1 sibling, 0 replies; 6+ messages in thread
From: Drew Adams @ 2014-02-08 23:05 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 15940

> Yeah, it's unfortunate that autoloaded functions can't really refer
> to other variables from its "home package" in the help system.
> 
> 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?

Sorry, I can't help you here.  But I'm sure Stefan has an idea about it.





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#15940: 24.3.50; doc string of `lwarn' refers to undefined variables
  2014-02-08 20:06     ` Glenn Morris
@ 2014-02-09  0:20       ` Glenn Morris
  0 siblings, 0 replies; 6+ messages in thread
From: Glenn Morris @ 2014-02-09  0:20 UTC (permalink / raw)
  To: 15940-done

Version: 24.4

Fixed.






^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2014-02-09  0:20 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
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
2014-02-09  0:20       ` Glenn Morris
2014-02-08 23:05   ` Drew Adams

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).