diff options
Diffstat (limited to 'doc/lispref/help.texi')
-rw-r--r-- | doc/lispref/help.texi | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index 298bec5230c..a788852de75 100644 --- a/doc/lispref/help.texi +++ b/doc/lispref/help.texi @@ -818,7 +818,7 @@ summaries of using those functions. The optional argument @var{functions} is a list whose elements are of the form: @lisp -(@var{func} @var{keyword} @var{val} @dots{}) +(@var{func} [@var{keyword} @var{val}]@dots{}) @end lisp The following keywords are recognized: @@ -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,17 +895,26 @@ 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}, respectively, but are inserted as is. This is useful when the result -is unreadable or should be on a particular form: +is unreadable or should be of a particular form: @example :no-eval (find-file "/tmp/foo") @@ -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. |