Mercurial > emacs
changeset 50799:80f5ff945c90
(help-add-fundoc-usage): Allow arglist to be a string.
author | Stefan Monnier <monnier@iro.umontreal.ca> |
---|---|
date | Sun, 04 May 2003 00:30:34 +0000 |
parents | 2d72cdb7e9f8 |
children | 7fe53d25e220 |
files | lisp/help-fns.el |
diffstat | 1 files changed, 7 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/help-fns.el Sun May 04 00:13:06 2003 +0000 +++ b/lisp/help-fns.el Sun May 04 00:30:34 2003 +0000 @@ -175,15 +175,19 @@ (defun help-add-fundoc-usage (doc arglist) "Add the usage info to the docstring DOC. If DOC already has a usage info, then just return DOC unchanged. -The usage info is built from ARGLIST. DOC can be nil." +The usage info is built from ARGLIST. DOC can be nil. +ARGLIST can also be nil or a string of the form \"(fun ARG1 ARG2 ...)\"." (unless (stringp doc) (setq doc "Not documented")) - (if (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" doc) + (if (or (string-match "\n\n(fn\\(\\( .*\\)?)\\)\\'" doc) (not arglist)) doc (format "%s%s%s" doc (if (string-match "\n?\n\\'" doc) (if (< (- (match-end 0) (match-beginning 0)) 2) "\n" "") "\n\n") - (help-make-usage 'fn arglist)))) + (if (and (stringp arglist) + (string-match "\\`([^ ]+\\(.*\\))\\'" arglist)) + (concat "(fn" (match-string 1 arglist) ")") + (help-make-usage 'fn arglist))))) (defun help-function-arglist (def) ;; Handle symbols aliased to other symbols.