is there C-h help for a "require" feature?

is there C-h help for a "require" feature?

[Robert P. J. Day]

  looking at someone else's elisp load file, and for the line
(require 'cl), is there any C-h help for "cl"?  given that it's
not a function or variable, is there another C-h key sequence
that would give help for that, perhaps from embedded documentation
in the corresponding file?

rday

Re: is there C-h help for a "require" feature?

[Jesper Harder]

"Robert P. J. Day" <rpjday@mindspring.com> writes:

>   looking at someone else's elisp load file, and for the line (require
> 'cl), is there any C-h help for "cl"?  given that it's not a function
> or variable, is there another C-h key sequence that would give help
> for that, perhaps from embedded documentation in the corresponding
> file?

There's `M-x finder-commentary'.

Re: is there C-h help for a "require" feature?

[Michael J. Barillier]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

>>>>> "rd" == Robert P J Day <rpjday@mindspring.com> writes:

    rd>   looking at someone else's elisp load file, and for the line
    rd> (require 'cl), is there any C-h help for "cl"?  given that
    rd> it's not a function or variable, is there another C-h key
    rd> sequence that would give help for that, perhaps from embedded
    rd> documentation in the corresponding file?

`(require 'cl)' makes sure cl.el (Common Lisp-like functions) are
loaded.  `cl' is just a symbol, and if it's not in the `features' list
then the corresponding file is loaded.  Are you looking for some
method of attaching per-file documentation?  Sounds like a slick idea,
but not supported by the current `require'/`provide' mechanism
(AFAIK).

- -- 
Michael J. Barillier
(let ((n "blackwolf") (h "pcisys.net")) (concatenate 'string n "@" h))
GnuPG public key ID: 0x35E54973
Fingerprint: EDB9 4FBC 4D0B 070C C0E3 2EE4 D822 78CE 35E5 4973
``A designer knows he has achieved perfection not when there is nothing
left to add, but when there is nothing left to take away.''
        -- Antoine de Saint-Exupery
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.0 (GNU/Linux)

iD8DBQE9ljja2CJ4zjXlSXMRAjy7AJ9pKYRTmDutFmwXEuHVrStcFuZlNQCfcYj2
nJOZFBOH2LA0VrC7wAyoLiQ=
=Y5bv
-----END PGP SIGNATURE-----

Re: is there C-h help for a "require" feature?

[Robert P. J. Day]

On Sat, 28 Sep 2002, Michael J. Barillier wrote:

> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
> 
> >>>>> "rd" == Robert P J Day <rpjday@mindspring.com> writes:
> 
>     rd>   looking at someone else's elisp load file, and for the line
>     rd> (require 'cl), is there any C-h help for "cl"?  given that
>     rd> it's not a function or variable, is there another C-h key
>     rd> sequence that would give help for that, perhaps from embedded
>     rd> documentation in the corresponding file?
> 
> `(require 'cl)' makes sure cl.el (Common Lisp-like functions) are
> loaded.  `cl' is just a symbol, and if it's not in the `features' list
> then the corresponding file is loaded.

that part i had pretty much figured out.

> Are you looking for some
> method of attaching per-file documentation?  Sounds like a slick idea,
> but not supported by the current `require'/`provide' mechanism

that's what i was asking about, kind of like the DOCSTRING part of
a "defvar".  ah well, it was a shot in the dark.

rday

Re: is there C-h help for a "require" feature?

[Stefan Monnier <foo@acm.com>]

> that's what i was asking about, kind of like the DOCSTRING part of
> a "defvar".  ah well, it was a shot in the dark.

You can take a look at (cdr (assoc "cl" load-library)) to see
what functions/variables are defined.


        Stefan