diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2020-10-11 17:28:40 +0300 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2020-10-11 17:28:40 +0300 |
| commit | 4b84095d2373eb0b26308d6c622ce9ab89a0efa5 (patch) | |
| tree | b4eb3274a71923b015253e2dca78121a37bff6fa /lisp/emacs-lisp/shortdoc.el | |
| parent | 2e8736eaa356fa274bd5852fe6921849fcbd494c (diff) | |
| download | emacs-4b84095d2373eb0b26308d6c622ce9ab89a0efa5.tar.gz emacs-4b84095d2373eb0b26308d6c622ce9ab89a0efa5.tar.bz2 emacs-4b84095d2373eb0b26308d6c622ce9ab89a0efa5.zip | |
Improve documentation of shortdoc features
* lisp/help-fns.el (help-fns-describe-function-functions): Doc
fix.
* lisp/emacs-lisp/shortdoc.el (define-short-documentation-group)
(shortdoc-display-group, shortdoc-add-function): Doc fixes.
* doc/lispref/help.texi (Documentation Groups): Improve the
recently-added documentation and the indexing.
Diffstat (limited to 'lisp/emacs-lisp/shortdoc.el')
| -rw-r--r-- | lisp/emacs-lisp/shortdoc.el | 13 |
1 files changed, 7 insertions, 6 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: |