all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Lennart Borgman (gmail)" <lennart.borgman@gmail.com>
To: Jason Rumney <jasonr@gnu.org>
Cc: rms@gnu.org, emacs-devel@gnu.org
Subject: Re: Suggestion: Let the help command load autoloaded functions etc
Date: Fri, 21 Dec 2007 18:35:43 +0100	[thread overview]
Message-ID: <476BF96F.6000109@gmail.com> (raw)
In-Reply-To: <476BED2D.2070700@gnu.org>

Jason Rumney wrote:
> Lennart Borgman (gmail) wrote:
>> Jason Rumney wrote:
>>> What benefit do you suppose would be gained from doing this?
>> A few things:
>>
>> - Argument list
>> - Correct doc string
>> - Links in doc string
>>
> 
> I don't see what you mean by the first two. When I use C-h f 5x5, for
> example (without having loaded 5x5 previously), I see the arg list, and
> the documentation is correct. Under what circumstances do you get
> incorrect documentation and no arg list?

Not sure, but it looks to me like it will be correct if you use

   ;;;###autoload

before the function. However if you do something like

   (autoload '5x1 "5x1" "Play 5x1" t)

you will just get what is on this line.

I believe many people are writing autoload's the second way. Maybe 
something like this in autoload.el could be helpful:

   (defun generate-library-autoloads (library)
     "Insert at point autoloads for Emacs library LIBRARY.
   Works like `generate-file-autoloads', but for a library."
     (interactive
      (list (completing-read "Generate autoloads for library: "
                             'locate-file-completion
                             (cons load-path (get-load-suffixes)))))
     (let ((file (locate-library library)))
       (generate-file-autoloads file)))

But that does not cure the third problem, that links in autoloaded 
functions doc strings often does not work because they point to other 
things in the same yet not loaded library where the function is defined.

I still believe me suggestion for a better [Args not available ...] 
string is useful. It could be expanded to the ;;;###autoload cookie 
case, maybe by adding something at the end of the description.

  reply	other threads:[~2007-12-21 17:35 UTC|newest]

Thread overview: 32+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2007-12-19 18:26 Suggestion: Let the help command load autoloaded functions etc Lennart Borgman (gmail)
2007-12-21  3:05 ` Richard Stallman
2007-12-21  8:39   ` Lennart Borgman (gmail)
2007-12-21 10:44     ` Jason Rumney
2007-12-21 16:20       ` Lennart Borgman (gmail)
2007-12-21 16:43         ` Jason Rumney
2007-12-21 17:35           ` Lennart Borgman (gmail) [this message]
2007-12-21 17:40             ` Leo
2007-12-21 18:46               ` Lennart Borgman (gmail)
2007-12-22  9:57                 ` Eli Zaretskii
2007-12-22  6:30         ` Richard Stallman
2007-12-22 10:36           ` Thien-Thi Nguyen
2007-12-22 10:42             ` Lennart Borgman (gmail)
2007-12-22 10:45               ` Lennart Borgman (gmail)
2007-12-22 11:23               ` Robert J. Chassell
2007-12-22 11:44               ` Thien-Thi Nguyen
2007-12-22 21:08             ` Richard Stallman
2008-07-16 10:28           ` Lennart Borgman (gmail)
2008-07-16 10:54             ` David Kastrup
2008-07-16 11:01               ` Lennart Borgman (gmail)
2008-07-16 11:08                 ` David Kastrup
2008-07-16 11:55                   ` Lennart Borgman
2008-07-16 19:02                     ` Stephen J. Turnbull
2008-07-16 19:55                       ` David Kastrup
2008-07-16 21:11                         ` Lennart Borgman (gmail)
2008-07-16 22:40                         ` Stephen J. Turnbull
2008-07-17  6:36                           ` David Kastrup
2008-07-17  8:49                             ` Stephen J. Turnbull
2008-07-17  9:56                               ` David Kastrup
2008-07-17 10:41                                 ` Lennart Borgman (gmail)
2008-07-17 22:54                         ` Richard M Stallman
2007-12-22  6:29     ` Richard Stallman

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

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

  git send-email \
    --in-reply-to=476BF96F.6000109@gmail.com \
    --to=lennart.borgman@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=jasonr@gnu.org \
    --cc=rms@gnu.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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.