transient-enable-popup-navigation: Update documentation

magit · Oct 23, 2024 · 38f7f46 · 38f7f46
1 parent fcc54cb
commit 38f7f46
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 4 deletions.
diff --git a/docs/transient.org b/docs/transient.org
@@ -470,10 +470,15 @@ Also see [[* Common Suffix Commands]].
 
   - {{{kbd(UP)}}} moves the cursor to the previous suffix.
   - {{{kbd(DOWN)}}} moves the cursor to the next suffix.
-  - {{{kbd(RET)}}} invokes the suffix the cursor is on.
+  - {{{kbd(M-RET)}}} invokes the suffix the cursor is on.
   - {{{kbd(mouse-1)}}} invokes the clicked on suffix.
   - {{{kbd(C-s)}}} and {{{kbd(C-r)}}} start isearch in the popup buffer.
 
+  By default {{{kbd(M-RET)}}} is bound to ~transient-push-button~, instead of
+  {{{kbd(RET)}}}, because if a transient allows the invocation of non-suffixes,
+  then it is likely, that you would want {{{kbd(RET)}}} to do what it would do
+  if no transient were active."
+
 - User Option: transient-display-buffer-action ::
 
   This option specifies the action used to display the transient popup

diff --git a/docs/transient.texi b/docs/transient.texi
@@ -631,12 +631,17 @@ is non-@code{nil}, then the following features are available:
 @item
 @kbd{@key{DOWN}} moves the cursor to the next suffix.
 @item
-@kbd{@key{RET}} invokes the suffix the cursor is on.
+@kbd{M-@key{RET}} invokes the suffix the cursor is on.
 @item
 @kbd{mouse-1} invokes the clicked on suffix.
 @item
 @kbd{C-s} and @kbd{C-r} start isearch in the popup buffer.
 @end itemize
+
+By default @kbd{M-@key{RET}} is bound to @code{transient-push-button}, instead of
+@kbd{@key{RET}}, because if a transient allows the invocation of non-suffixes,
+then it is likely, that you would want @kbd{@key{RET}} to do what it would do
+if no transient were active."
 @end defopt
 
 @defopt transient-display-buffer-action

diff --git a/lisp/transient.el b/lisp/transient.el
@@ -162,8 +162,8 @@ bindings are available:
 All other bindings are in `transient-popup-navigation-map'.
 
 By default \\`M-RET' is bound to `transient-push-button', instead of
-\\`RET', because if a transient allows the invocation of non-suffixes
-then it is likely that you would want \\`RET' to do what it would do
+\\`RET', because if a transient allows the invocation of non-suffixes,
+then it is likely, that you would want \\`RET' to do what it would do
 if no transient were active."
   :package-version '(transient . "0.4.0")
   :group 'transient