branch: externals/transient
commit b49e79df00d1ab4837def3fc354fa723b7ff6a18
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
manual: Use new "codevar" macro
---
docs/.orgconfig | 1 +
docs/transient.org | 6 +++---
docs/transient.texi | 6 +++---
3 files changed, 7 insertions(+), 6 deletions(-)
diff --git a/docs/.orgconfig b/docs/.orgconfig
index acfbd0fdcf..92cfc92bae 100644
--- a/docs/.orgconfig
+++ b/docs/.orgconfig
@@ -9,5 +9,6 @@
#+macro: var @@texinfo:@var{@@$1@@texinfo:}@@
#+macro: kbdvar (eval (format "@@texinfo:@kbd{@@%s@@texinfo:}@@" (let
(case-fold-search) (replace-regexp-in-string "<\\([a-zA-Z-]+\\)>"
"@@texinfo:@var{@@\\1@@texinfo:}@@" (replace-regexp-in-string
org-texinfo--quoted-keys-regexp "@@texinfo:@key{@@\\&@@texinfo:}@@" $1 t) t))))
+#+macro: codevar (eval (let (case-fold-search) (format
"@@texinfo:@code{@@%s@@texinfo:}@@" (replace-regexp-in-string
"\\([A-Z][A-Z-]+\\)" "@@texinfo:@var{@@\\&@@texinfo:}@@" $1 t))))
#+language: en
diff --git a/docs/transient.org b/docs/transient.org
index d23b8e1d33..ff4e35aaf0 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -540,9 +540,9 @@ Also see [[* Common Suffix Commands]].
This option specifies the action used to display the transient popup
buffer. The transient popup buffer is displayed in a window using
- ~(display-buffer BUFFER transient-display-buffer-action)~.
+ {{{codevar((display-buffer BUFFER transient-display-buffer-action))}}}.
- The value of this option has the form ~(FUNCTION . ALIST)~,
+ The value of this option has the form {{{codevar((FUNCTION . ALIST))}}},
where {{{var(FUNCTION)}}} is a function or a list of functions. Each such
function should accept two arguments: a buffer to display and an
alist of the same form as {{{var(ALIST)}}}. See [[info:elisp#Choosing
Window]],
@@ -771,7 +771,7 @@ The following functions share a few arguments:
These functions operate on the information stored in the
~transient--layout~ property of the {{{var(PREFIX)}}} symbol. Suffix entries
in
-that tree are not objects but have the form ~(LEVEL CLASS PLIST)~, where
+that tree are not objects but have the form {{{codevar((LEVEL CLASS
PLIST))}}}, where
{{{var(PLIST)}}} should set at least ~:key~, ~:description~ and ~:command~.
- Function: transient-insert-suffix prefix loc suffix &optional keep-other ::
diff --git a/docs/transient.texi b/docs/transient.texi
index 34589c92f6..2d06cefcf3 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -708,9 +708,9 @@ is non-@code{nil}, then the following features are
available:
@defopt transient-display-buffer-action
This option specifies the action used to display the transient popup
buffer. The transient popup buffer is displayed in a window using
-@code{(display-buffer BUFFER transient-display-buffer-action)}.
+@code{(display-buffer @var{BUFFER} transient-display-buffer-action)}.
-The value of this option has the form @code{(FUNCTION . ALIST)},
+The value of this option has the form @code{(@var{FUNCTION} . @var{ALIST})},
where @var{FUNCTION} is a function or a list of functions. Each such
function should accept two arguments: a buffer to display and an
alist of the same form as @var{ALIST}. See @ref{Choosing Window,,,elisp,},
@@ -939,7 +939,7 @@ at the definition of the transient prefix command.
These functions operate on the information stored in the
@code{transient--layout} property of the @var{PREFIX} symbol. Suffix entries
in
-that tree are not objects but have the form @code{(LEVEL CLASS PLIST)}, where
+that tree are not objects but have the form @code{(@var{LEVEL} @var{CLASS}
@var{PLIST})}, where
@var{PLIST} should set at least @code{:key}, @code{:description} and
@code{:command}.
@defun transient-insert-suffix prefix loc suffix &optional keep-other
