aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--doc/lispref/help.texi18
-rw-r--r--lisp/emacs-lisp/shortdoc.el2
2 files changed, 16 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:
839@end example 839@end example
840 840
841@noindent 841@noindent
842will be printed as 842will result in:
843 843
844@example 844@example
845(concat "foo" "bar" "zot") 845(concat "foo" "bar" "zot")
@@ -866,13 +866,14 @@ should be included.
866@end example 866@end example
867 867
868@item :no-eval* 868@item :no-eval*
869Like @code{:no-eval}, but alaways inserts @samp{[it depends]} as the 869Like @code{:no-eval}, but always inserts @samp{[it depends]} as the
870result. 870result. For instance:
871 871
872@example 872@example
873:no-eval* (buffer-string) 873:no-eval* (buffer-string)
874@end example 874@end example
875 875
876@noindent
876will result in: 877will result in:
877 878
878@example 879@example
@@ -894,12 +895,21 @@ Used to output the result from non-evaluating example forms.
894 895
895@item :eg-result 896@item :eg-result
896Used to output an example result from non-evaluating example forms. 897Used to output an example result from non-evaluating example forms.
898For instance:
897 899
898@example 900@example
899:no-eval (looking-at "f[0-9]") 901:no-eval (looking-at "f[0-9]")
900:eg-result t 902:eg-result t
901@end example 903@end example
902 904
905@noindent
906will result in:
907
908@example
909(looking-at "f[0-9]")
910eg. @click{} t
911@end example
912
903@item :result-string 913@item :result-string
904@itemx :eg-result-string 914@itemx :eg-result-string
905These two are the same as @code{:result} and @code{:eg-result}, 915These two are the same as @code{:result} and @code{:eg-result},
@@ -951,7 +961,7 @@ sections.
951 961
952@defun shortdoc-add-function shortdoc-add-function group section elem 962@defun shortdoc-add-function shortdoc-add-function group section elem
953Lisp packages can add functions to groups with this command. Each 963Lisp packages can add functions to groups with this command. Each
954@var{elem} should be a function descriptions, as described above. 964@var{elem} should be a function description, as described above.
955@var{group} is the function group, and @var{section} is what section 965@var{group} is the function group, and @var{section} is what section
956in the function group to insert the function into. 966in the function group to insert the function into.
957 967
diff --git a/lisp/emacs-lisp/shortdoc.el b/lisp/emacs-lisp/shortdoc.el
index 38d8ad6cc12..c9484dcb686 100644
--- a/lisp/emacs-lisp/shortdoc.el
+++ b/lisp/emacs-lisp/shortdoc.el
@@ -60,8 +60,10 @@ FUNCTIONS is a list of elements on the form:
60 :args ARGS 60 :args ARGS
61 :eval EXAMPLE-FORM 61 :eval EXAMPLE-FORM
62 :no-eval EXAMPLE-FORM 62 :no-eval EXAMPLE-FORM
63 :no-eval* EXAMPLE-FORM
63 :no-value EXAMPLE-FORM 64 :no-value EXAMPLE-FORM
64 :result RESULT-FORM 65 :result RESULT-FORM
66 :result-string RESULT-FORM
65 :eg-result RESULT-FORM 67 :eg-result RESULT-FORM
66 :eg-result-string RESULT-FORM) 68 :eg-result-string RESULT-FORM)
67 69