diff options
| author | Basil L. Contovounesios <contovob@tcd.ie> | 2021-06-21 16:00:39 +0100 |
|---|---|---|
| committer | Basil L. Contovounesios <contovob@tcd.ie> | 2021-06-21 16:20:22 +0100 |
| commit | 3b1d69efc32c8929281f38d55cef773e4680f2ad (patch) | |
| tree | 12dc2807a8a035e0436b09655758d16a22d6c553 /doc/lispref/help.texi | |
| parent | 09f17ac4752e18bf834d2f20ceef561cc516d917 (diff) | |
| download | emacs-3b1d69efc32c8929281f38d55cef773e4680f2ad.tar.gz emacs-3b1d69efc32c8929281f38d55cef773e4680f2ad.tar.bz2 emacs-3b1d69efc32c8929281f38d55cef773e4680f2ad.zip | |
Fix shortdoc-add-function section creation
* lisp/emacs-lisp/shortdoc.el (shortdoc-add-function): Use nconc to
actually append a new section to the list of groups while avoiding a
previous OBOE. Push a new group to the front of shortdoc--groups
without copying it, just like define-short-documentation-group does.
(buffer): Fix copypasta in unlock-buffer example.
* test/lisp/emacs-lisp/shortdoc-tests.el (shortdoc-examples): Also
check that :no-value forms demonstrate the right function.
* doc/lispref/help.texi (Documentation Groups): Clarify that @dots
in the define-short-documentation-group arglist refer to whole
key-value pairs. Fix typo in :eg-result-string description.
Diffstat (limited to 'doc/lispref/help.texi')
| -rw-r--r-- | doc/lispref/help.texi | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/lispref/help.texi b/doc/lispref/help.texi index dbbc34fb3a5..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: @@ -914,7 +914,7 @@ eg. @click{} t @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") |