comparison lisp/ChangeLog @ 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 2ac296807b88
children 0d6d0edf1253
comparison
equal deleted inserted replaced
4694:2ac296807b88 4695:fee33ab25966
1 2009-09-20 Aidan Kehoe <kehoea@parhasard.net>
2
3 Add arglist information to docstrings for autoloaded functions and
4 macros.
5 * hyper-apropos.el (hyper-apropos-get-doc):
6 Treat autoload docstrings like subr docstrings; correct the regexp
7 used.
8 * help.el (describe-function-show-arglist):
9 This no longer treats autoloads specially.
10 (function-arglist): Treat autoload docstrings like subr docstrings.
11 (function-documentation): Treat documentation strings that are
12 zero-length after the arglist has been removed as indicating a
13 lack of documentation.
14 * cl-macs.el (case):
15 (ecase):
16 (typecase):
17 (etypecase):
18 (block):
19 (return):
20 (return-from):
21 (progv):
22 (lexical-let):
23 (lexical-let*):
24 (remf):
25 (callf):
26 (callf2):
27 (define-modify-macro):
28 (deftype):
29 (define-compiler-macro):
30 Rely on the autoload code to always show an arglist for these
31 functions, don't supply an ad-hoc one in the docstring.
32 These changes are for the most obvious functions; there are some
33 missed that would require changing argument names in the docstring
34 or in the function bodies.
35 * autoload.el (make-autoload):
36 Add arg list information to the doc string, using the same
37 approach as for subrs.
38
1 2009-09-20 Aidan Kehoe <kehoea@parhasard.net> 39 2009-09-20 Aidan Kehoe <kehoea@parhasard.net>
2 40
3 * help.el (function-arglist): 41 * help.el (function-arglist):
4 Show the double-quotes in the sample output, correctly. 42 Show the double-quotes in the sample output, correctly.
5 Bind print-gensym to nil, now we're using uninterned symbols. 43 Bind print-gensym to nil, now we're using uninterned symbols.