summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/transient.org19
-rw-r--r--docs/transient.texi20
2 files changed, 39 insertions, 0 deletions
diff --git a/docs/transient.org b/docs/transient.org
index ed92eea..58b0593 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -2083,6 +2083,25 @@ object should not affect later invocations.
it is somewhat likely that future improvements won't be fully
backward compatible.
+- The ~transient-cons-option~ class is intended for situations where
+ ~transient-args~ should return an alist, instead of a list of strings
+ (arguments). Such suffixes can be specified in prefix definitions
+ like so:
+
+ #+begin_src emacs-lisp
+ (:cons OPTION :key KEY [KEYWORD VALUE]...)
+ #+end_src
+
+ OPTION may be something other than a string, likely a keyword or
+ some other symbol, it is used as the ~car~ of the cons-cell. When
+ using such an inline definition ~:key~ has to be specified. In most
+ cases ~:reader~ should also be specified. When defining such a suffix
+ separately, the "alist key" has to be specified using the ~:variable~
+ keyword argument.
+
+ This class is still experimental it is somewhat likely that future
+ improvements won't be fully backward compatible.
+
- The ~transient-describe-target~ class is used by the command
~transient-describe~.
diff --git a/docs/transient.texi b/docs/transient.texi
index 4576cc6..0f1a837 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -2333,6 +2333,26 @@ it is somewhat likely that future improvements won't be fully
backward compatible.
@item
+The @code{transient-cons-option} class is intended for situations where
+@code{transient-args} should return an alist, instead of a list of strings
+(arguments). Such suffixes can be specified in prefix definitions
+like so:
+
+@lisp
+(:cons OPTION :key KEY [KEYWORD VALUE]...)
+@end lisp
+
+OPTION may be something other than a string, likely a keyword or
+some other symbol, it is used as the @code{car} of the cons-cell. When
+using such an inline definition @code{:key} has to be specified. In most
+cases @code{:reader} should also be specified. When defining such a suffix
+separately, the "alist key" has to be specified using the @code{:variable}
+keyword argument.
+
+This class is still experimental it is somewhat likely that future
+improvements won't be fully backward compatible.
+
+@item
The @code{transient-describe-target} class is used by the command
@code{transient-describe}.