Skip to content

Commit dceb28a

Browse files
committed
Update to Transient v0.7.0-1-g482bc777
1 parent dc30834 commit dceb28a

File tree

2 files changed

+231
-167
lines changed

2 files changed

+231
-167
lines changed

doc/misc/transient.texi

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ General Public License for more details.
3131
@finalout
3232
@titlepage
3333
@title Transient User and Developer Manual
34-
@subtitle for version 0.6.0
34+
@subtitle for version 0.7.0
3535
@author Jonas Bernoulli
3636
@page
3737
@vskip 0pt plus 1filll
@@ -53,7 +53,7 @@ resource to get over that hurdle is Psionic K's interactive tutorial,
5353
available at @uref{https://github.com/positron-solutions/transient-showcase}.
5454

5555
@noindent
56-
This manual is for Transient version 0.6.0.
56+
This manual is for Transient version 0.7.0.
5757

5858
@insertcopying
5959
@end ifnottex
@@ -1112,7 +1112,8 @@ Transients}) and adds the transient's infix and suffix bindings, as
11121112
described below.
11131113

11141114
Users and third-party packages can add additional bindings using
1115-
functions such as @code{transient-insert-suffix} (@pxref{Modifying Existing Transients}). These functions take a ``suffix specification'' as one of
1115+
functions such as @code{transient-insert-suffix} (@pxref{Modifying Existing Transients}).
1116+
These functions take a ``suffix specification'' as one of
11161117
their arguments, which has the same form as the specifications used in
11171118
@code{transient-define-prefix}.
11181119

@@ -1380,16 +1381,12 @@ This macro defines @var{NAME} as a transient infix command.
13801381
reserved for future use. @var{DOCSTRING} is the documentation string and
13811382
is optional.
13821383

1383-
The keyword-value pairs are mandatory. All transient infix commands
1384-
are @code{equal} to each other (but not @code{eq}), so it is meaningless to define
1385-
an infix command without also setting at least @code{:class} and one other
1386-
keyword (which it is depends on the used class, usually @code{:argument} or
1387-
@code{:variable}).
1388-
1389-
Each keyword has to be a keyword symbol, either @code{:class} or a keyword
1390-
argument supported by the constructor of that class. The
1391-
@code{transient-switch} class is used if the class is not specified
1392-
explicitly.
1384+
At least one key-value pair is required. All transient infix
1385+
commands are @code{equal} to each other (but not @code{eq}). It is meaningless
1386+
to define an infix command, without providing at least one keyword
1387+
argument (usually @code{:argument} or @code{:variable}, depending on the class).
1388+
The suffix class defaults to @code{transient-switch} and can be set using
1389+
the @code{:class} keyword.
13931390

13941391
The function definition is always:
13951392

@@ -2372,6 +2369,20 @@ the transient popup, you will be able to yank it in another buffer.
23722369
#'transient--do-stay)
23732370
@end lisp
23742371

2372+
@anchor{How can I autoload prefix and suffix commands?}
2373+
@appendixsec How can I autoload prefix and suffix commands?
2374+
2375+
If your package only supports Emacs 30, just prefix the definition
2376+
with @code{;;;###autoload}. If your package supports released versions of
2377+
Emacs, you unfortunately have to use a long form autoload comment
2378+
as described in @ref{Autoload,,,elisp,}.
2379+
2380+
@lisp
2381+
;;;###autoload (autoload 'magit-dispatch "magit" nil t)
2382+
(transient-define-prefix magit-dispatch ()
2383+
...)
2384+
@end lisp
2385+
23752386
@anchor{How does Transient compare to prefix keys and universal arguments?}
23762387
@appendixsec How does Transient compare to prefix keys and universal arguments?
23772388

0 commit comments

Comments
 (0)