diff options
author | Daniel MartÃn <mardani29@yahoo.es> | 2021-05-30 06:41:24 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2021-05-30 06:41:24 +0200 |
commit | 1230651ffdf7c271db4bb2901ea23298fcd9ecf3 (patch) | |
tree | 5e9ad570d38335b6dd42d753d21970d7d3c97252 /doc/lispref/help.texi | |
parent | b0d01982e2d5732390806ec5bbec6ebc01172601 (diff) | |
download | emacs-1230651ffdf7c271db4bb2901ea23298fcd9ecf3.tar.gz |
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)
Diffstat (limited to 'doc/lispref/help.texi')
-rw-r--r-- | doc/lispref/help.texi | 18 |
1 files changed, 14 insertions, 4 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 298bec5230c..dbbc34fb3a5 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -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. |