diff options
Diffstat (limited to 'lisp')
| -rw-r--r-- | lisp/emacs-lisp/shortdoc.el | 13 | ||||
| -rw-r--r-- | lisp/help-fns.el | 4 |
2 files changed, 9 insertions, 8 deletions
diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el index 1843db81093..eaa4ece7b90 100644 --- a/lisp/emacs-lisp/shortdoc.el +++ b/lisp/emacs-lisp/shortdoc.el @@ -67,13 +67,13 @@ FUNCTIONS is a list of elements on the form: BOOL should be non-nil if the function isn't documented in the manual. -ARGS is optional, and the functions definition is displayed -instead in not present. +ARGS is optional; the function's signature is displayed if ARGS +is not present. If EVAL isn't a string, it will be printed with `prin1', and then -evaled to give a result, which is also printed. If it's a +evaluated to give a result, which is also printed. If it's a string, it'll be inserted as is, then the string will be `read', -and then evaled. +and then evaluated. There can be any number of :example/:result elements." `(progn @@ -957,8 +957,8 @@ There can be any number of :example/:result elements." ;;;###autoload (defun shortdoc-display-group (group) - "Pop to a buffer and display short documentation for functions in GROUP." - (interactive (list (completing-read "Show functions in: " + "Pop to a buffer with short documentation summary for functions in GROUP." + (interactive (list (completing-read "Show summary for functions in: " (mapcar #'car shortdoc--groups)))) (when (stringp group) (setq group (intern group))) @@ -1079,6 +1079,7 @@ There can be any number of :example/:result elements." (defun shortdoc-add-function (group section elem) "Add ELEM to shortdoc GROUP in SECTION. +If GROUP doesn't exist, it will be created. If SECTION doesn't exist, it will be added. Example: diff --git a/lisp/help-fns.el b/lisp/help-fns.el index ee626ebc709..07b4c406f0c 100644 --- a/lisp/help-fns.el +++ b/lisp/help-fns.el @@ -40,8 +40,8 @@ (defvar help-fns-describe-function-functions nil "List of functions to run in help buffer in `describe-function'. Those functions will be run after the header line and argument -list was inserted, and before the documentation will be inserted. -The functions will receive the function name as argument. +list was inserted, and before the documentation is be inserted. +The functions will be called with one argument: the function's symbol. They can assume that a newline was output just before they were called, and they should terminate any of their own output with a newline. By convention they should indent their output by 2 spaces.") |