diff options
| author | Stefan Monnier <monnier@iro.umontreal.ca> | 2003-05-04 00:30:34 +0000 |
|---|---|---|
| committer | Stefan Monnier <monnier@iro.umontreal.ca> | 2003-05-04 00:30:34 +0000 |
| commit | 95734598cd99ef979c4a2067306d835c67186aad (patch) | |
| tree | 9569c0ee306b817c592ddeb3b1d3e36e1cd65fe0 /lisp/help-fns.el | |
| parent | 9d3153eb8706b7b0bd9cac77ac0e72a7bd6bb661 (diff) | |
| download | emacs-95734598cd99ef979c4a2067306d835c67186aad.tar.gz emacs-95734598cd99ef979c4a2067306d835c67186aad.tar.bz2 emacs-95734598cd99ef979c4a2067306d835c67186aad.zip | |
(help-add-fundoc-usage): Allow arglist to be a string.
Diffstat (limited to 'lisp/help-fns.el')
| -rw-r--r-- | lisp/help-fns.el | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/lisp/help-fns.el b/lisp/help-fns.el index 41b002c7e79..c6011b62e97 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -175,15 +175,19 @@ DEF is the function whose usage we're looking for in DOC." (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. |