summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonas Bernoulli <jonas@bernoul.li>2026-02-23 10:46:05 +0100
committerJonas Bernoulli <jonas@bernoul.li>2026-02-23 10:46:05 +0100
commit4d283706a8c51400516a3f6344b8859a90cad900 (patch)
tree8bfcd242e6a4238bbd0fb77091bcc86aa9ae5f55 /docs
parentd30d4308f198bc0b3d0ab60c855bd1b99176ef8d (diff)
transient-get-summary: Optionally echo even duplicated documentation
Diffstat (limited to 'docs')
-rw-r--r--docs/transient.org24
-rw-r--r--docs/transient.texi24
2 files changed, 36 insertions, 12 deletions
diff --git a/docs/transient.org b/docs/transient.org
index 7da7e72..be5332b 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -600,14 +600,21 @@ Two more essential options are documented in [[* Common Suffix Commands]].
- User Option: transient-enable-menu-navigation ::
This option controls whether navigation commands are enabled in
- transient's menu buffer. If the value is ~verbose~ (the default),
- brief documentation about the command under point is additionally
- show in the echo area.
+ transient menu buffer, and whether additional documentation is shown
+ in the echo area while doing so.
+
+ If the value is ~verbose~ (the default), additional documentation
+ about the command at point is shown in the echo area. If this would
+ result in the same documentation, which is being displayed inside
+ the menu buffer, to be duplicated in the echo area, then ~verbose~
+ forgoes doing so. Use ~force-verbose~ to echo even such documentation.
+ Use ~t~ to enable menu navigation without showing documentation in the
+ echo area.
While a transient is active, the menu buffer is (by default) not the
current buffer, making it necessary to use dedicated commands to act
- on that buffer itself. If this option is non-nil, then the following
- bindings are available:
+ on that buffer itself. If this option is non-nil, then the
+ following bindings are available:
- {{{kbd(UP)}}} moves the cursor to the previous suffix.
- {{{kbd(DOWN)}}} moves the cursor to the next suffix.
@@ -700,7 +707,12 @@ text at point, to be run when a transient menu is active, for example:
- User Option: transient-enable-menu-navigation ::
This option is documented in the previous node ([[* Essential
- Options]]).
+ Options]]). You might want to change the value from ~verbose~ to
+ ~force-verbose~, which causes information to be shown in the echo
+ area, even if it is identical to information already displayed in
+ the menu buffer. Whether that is useful to you depends on whether
+ your setup makes it easy to read the last message displayed in the
+ echo area.
- User Option: transient-navigate-to-group-descriptions ::
diff --git a/docs/transient.texi b/docs/transient.texi
index 3f98272..5a41ccb 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -749,14 +749,21 @@ element has to be accessed the same way as the older elements.
@defopt transient-enable-menu-navigation
This option controls whether navigation commands are enabled in
-transient's menu buffer. If the value is @code{verbose} (the default),
-brief documentation about the command under point is additionally
-show in the echo area.
+transient menu buffer, and whether additional documentation is shown
+in the echo area while doing so.
+
+If the value is @code{verbose} (the default), additional documentation
+about the command at point is shown in the echo area. If this would
+result in the same documentation, which is being displayed inside
+the menu buffer, to be duplicated in the echo area, then @code{verbose}
+forgoes doing so. Use @code{force-verbose} to echo even such documentation.
+Use @code{t} to enable menu navigation without showing documentation in the
+echo area.
While a transient is active, the menu buffer is (by default) not the
current buffer, making it necessary to use dedicated commands to act
-on that buffer itself. If this option is non-nil, then the following
-bindings are available:
+on that buffer itself. If this option is non-nil, then the
+following bindings are available:
@itemize
@item
@@ -853,7 +860,12 @@ text at point, to be run when a transient menu is active, for example:
@end lisp
@defopt transient-enable-menu-navigation
-This option is documented in the previous node (@ref{Essential Options}).
+This option is documented in the previous node (@ref{Essential Options}). You might want to change the value from @code{verbose} to
+@code{force-verbose}, which causes information to be shown in the echo
+area, even if it is identical to information already displayed in
+the menu buffer. Whether that is useful to you depends on whether
+your setup makes it easy to read the last message displayed in the
+echo area.
@end defopt
@defopt transient-navigate-to-group-descriptions