1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-03 22:20:52 -08:00

Improve the documentation of documentation groups

* doc/lispref/help.texi (Documentation Groups): Fix typos and add an
example.
* lisp/emacs-lisp/shortdoc.el (define-short-documentation-group): Add
:no-eval* and :result-string keywords to the docstring.  (Bug#48730)
This commit is contained in:
Daniel Martín 2021-05-30 06:41:24 +02:00 committed by Lars Ingebrigtsen
parent b0d01982e2
commit 1230651ffd
2 changed files with 16 additions and 4 deletions

View file

@ -839,7 +839,7 @@ evaluated, and the result used. For instance:
@end example
@noindent
will be printed as
will result in:
@example
(concat "foo" "bar" "zot")
@ -866,13 +866,14 @@ should be included.
@end example
@item :no-eval*
Like @code{:no-eval}, but alaways inserts @samp{[it depends]} as the
result.
Like @code{:no-eval}, but always inserts @samp{[it depends]} as the
result. For instance:
@example
:no-eval* (buffer-string)
@end example
@noindent
will result in:
@example
@ -894,12 +895,21 @@ Used to output the result from non-evaluating example forms.
@item :eg-result
Used to output an example result from non-evaluating example forms.
For instance:
@example
:no-eval (looking-at "f[0-9]")
:eg-result t
@end example
@noindent
will result in:
@example
(looking-at "f[0-9]")
eg. @click{} t
@end example
@item :result-string
@itemx :eg-result-string
These two are the same as @code{:result} and @code{:eg-result},
@ -951,7 +961,7 @@ sections.
@defun shortdoc-add-function shortdoc-add-function group section elem
Lisp packages can add functions to groups with this command. Each
@var{elem} should be a function descriptions, as described above.
@var{elem} should be a function description, as described above.
@var{group} is the function group, and @var{section} is what section
in the function group to insert the function into.

View file

@ -60,8 +60,10 @@ FUNCTIONS is a list of elements on the form:
:args ARGS
:eval EXAMPLE-FORM
:no-eval EXAMPLE-FORM
:no-eval* EXAMPLE-FORM
:no-value EXAMPLE-FORM
:result RESULT-FORM
:result-string RESULT-FORM
:eg-result RESULT-FORM
:eg-result-string RESULT-FORM)