annotate README @ 4695:fee33ab25966

Add arglist info for autoloaded functions and macros. lisp/ChangeLog addition: 2009-09-20 Aidan Kehoe <kehoea@parhasard.net> Add arglist information to docstrings for autoloaded functions and macros. * hyper-apropos.el (hyper-apropos-get-doc): Treat autoload docstrings like subr docstrings; correct the regexp used. * help.el (describe-function-show-arglist): This no longer treats autoloads specially. (function-arglist): Treat autoload docstrings like subr docstrings. (function-documentation): Treat documentation strings that are zero-length after the arglist has been removed as indicating a lack of documentation. * cl-macs.el (case): (ecase): (typecase): (etypecase): (block): (return): (return-from): (progv): (lexical-let): (lexical-let*): (remf): (callf): (callf2): (define-modify-macro): (deftype): (define-compiler-macro): Rely on the autoload code to always show an arglist for these functions, don't supply an ad-hoc one in the docstring. These changes are for the most obvious functions; there are some missed that would require changing argument names in the docstring or in the function bodies. * autoload.el (make-autoload): Add arg list information to the doc string, using the same approach as for subrs.
author Aidan Kehoe <kehoea@parhasard.net>
date Sun, 20 Sep 2009 23:50:05 +0100
parents d96db265d893
children 0ef278ff2894
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
623
3e13cd716cff [xemacs-hg @ 2001-06-22 01:51:40 by ben]
ben
parents: 434
diff changeset
1 This directory tree holds version 21.5 of XEmacs.
3e13cd716cff [xemacs-hg @ 2001-06-22 01:51:40 by ben]
ben
parents: 434
diff changeset
2
2564
d96db265d893 [xemacs-hg @ 2005-02-04 03:04:04 by ben]
ben
parents: 968
diff changeset
3 The information in this file has been superseded by the XEmacs FAQ.
623
3e13cd716cff [xemacs-hg @ 2001-06-22 01:51:40 by ben]
ben
parents: 434
diff changeset
4
2564
d96db265d893 [xemacs-hg @ 2005-02-04 03:04:04 by ben]
ben
parents: 968
diff changeset
5 The easiest way to read the FAQ is to go to
623
3e13cd716cff [xemacs-hg @ 2001-06-22 01:51:40 by ben]
ben
parents: 434
diff changeset
6
2564
d96db265d893 [xemacs-hg @ 2005-02-04 03:04:04 by ben]
ben
parents: 968
diff changeset
7 http://www.xemacs.org/Documentation/21.5/html/xemacs-faq_1.html
623
3e13cd716cff [xemacs-hg @ 2001-06-22 01:51:40 by ben]
ben
parents: 434
diff changeset
8
2564
d96db265d893 [xemacs-hg @ 2005-02-04 03:04:04 by ben]
ben
parents: 968
diff changeset
9 You can also the local copy of the FAQ inside XEmacs by using
d96db265d893 [xemacs-hg @ 2005-02-04 03:04:04 by ben]
ben
parents: 968
diff changeset
10 use Help->XEmacs FAQ from the menu, or `C-h F'.
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11
2564
d96db265d893 [xemacs-hg @ 2005-02-04 03:04:04 by ben]
ben
parents: 968
diff changeset
12 If you don't have XEmacs running and can't access the web,
d96db265d893 [xemacs-hg @ 2005-02-04 03:04:04 by ben]
ben
parents: 968
diff changeset
13 look directly at `man/xemacs-faq.texi' or `info/xemacs-faq.info'.
623
3e13cd716cff [xemacs-hg @ 2001-06-22 01:51:40 by ben]
ben
parents: 434
diff changeset
14
3e13cd716cff [xemacs-hg @ 2001-06-22 01:51:40 by ben]
ben
parents: 434
diff changeset
15