branch: externals/transient
commit d7a1e81440675e489fb3e4b063d716de827eaf14
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
transient-show-popup: Update documentation
---
docs/transient.org | 24 +++++++++++++++++-------
docs/transient.texi | 31 ++++++++++++++++++++++++-------
lisp/transient.el | 8 ++++----
3 files changed, 45 insertions(+), 18 deletions(-)
diff --git a/docs/transient.org b/docs/transient.org
index 8dc9543e57..591e88fceb 100644
--- a/docs/transient.org
+++ b/docs/transient.org
@@ -8,7 +8,7 @@
#+TEXINFO_DIR_CATEGORY: Emacs
#+TEXINFO_DIR_TITLE: Transient: (transient).
#+TEXINFO_DIR_DESC: Transient Commands
-#+SUBTITLE: for version 0.1.0 (v0.1.0-39-gb1da0ca+1)
+#+SUBTITLE: for version 0.1.0 (v0.1.0-65-gafdf1f0+1)
#+TEXINFO_DEFFN: t
#+OPTIONS: H:4 num:4 toc:2
@@ -37,7 +37,7 @@ Calling a suffix command usually causes the transient to be
exited
but suffix commands can also be configured to not exit the transient.
#+TEXINFO: @noindent
-This manual is for Transient version 0.1.0 (v0.1.0-39-gb1da0ca+1).
+This manual is for Transient version 0.1.0 (v0.1.0-65-gafdf1f0+1).
#+BEGIN_QUOTE
Copyright (C) 2018-2019 Jonas Bernoulli <jo...@bernoul.li>
@@ -480,11 +480,21 @@ window, and the key bindings are the same as for
~scroll-up-command~ and
This option controls whether the current transient's infix and
suffix commands are shown in the popup buffer.
- If ~t~ (the default), then the infix and suffix commands are shown as
- soon as the transient is invoked. If ~nil~, only a one line summary
- is shown until the user presses a key that forms an incomplete key
- sequence. If a number, behave as for ~nil~ but also show the commands
- after that many seconds of inactivity.
+ - If ~t~ (the default) then the popup buffer is shown as soon as a
+ transient prefix command is invoked.
+
+ - If ~nil~, then the popup buffer is not shown unless the user
+ explicitly requests it, by pressing an incomplete prefix key
+ sequence.
+
+ - If a number, then the a brief one-line summary is shown instead of
+ the popup buffer. If zero or negative, then not even that summary
+ is shown; only the pressed key itself is shown.
+
+ The popup is shown when the user explicitly requests it by
+ pressing an incomplete prefix key sequence. Unless this is zero,
+ then the popup is shown after that many seconds of inactivity
+ (using the absolute value).
- User Option: transient-display-buffer-action
diff --git a/docs/transient.texi b/docs/transient.texi
index 49f9fe5a2d..daa5ddc25d 100644
--- a/docs/transient.texi
+++ b/docs/transient.texi
@@ -31,7 +31,7 @@ General Public License for more details.
@finalout
@titlepage
@title Transient User and Developer Manual
-@subtitle for version 0.1.0 (v0.1.0-39-gb1da0ca+1)
+@subtitle for version 0.1.0 (v0.1.0-65-gafdf1f0+1)
@author Jonas Bernoulli
@page
@vskip 0pt plus 1filll
@@ -65,7 +65,7 @@ Calling a suffix command usually causes the transient to be
exited
but suffix commands can also be configured to not exit the transient.
@noindent
-This manual is for Transient version 0.1.0 (v0.1.0-39-gb1da0ca+1).
+This manual is for Transient version 0.1.0 (v0.1.0-65-gafdf1f0+1).
@quotation
Copyright (C) 2018-2019 Jonas Bernoulli <jonas@@bernoul.li>
@@ -650,11 +650,28 @@ is a wrapper around @code{scroll-down-command} (which
see).
This option controls whether the current transient's infix and
suffix commands are shown in the popup buffer.
-If @code{t} (the default), then the infix and suffix commands are shown as
-soon as the transient is invoked. If @code{nil}, only a one line summary
-is shown until the user presses a key that forms an incomplete key
-sequence. If a number, behave as for @code{nil} but also show the commands
-after that many seconds of inactivity.
+@itemize
+@item
+If @code{t} (the default) then the popup buffer is shown as soon as a
+transient prefix command is invoked.
+
+
+@item
+If @code{nil}, then the popup buffer is not shown unless the user
+explicitly requests it, by pressing an incomplete prefix key
+sequence.
+
+
+@item
+If a number, then the a brief one-line summary is shown instead of
+the popup buffer. If zero or negative, then not even that summary
+is shown; only the pressed key itself is shown.
+
+The popup is shown when the user explicitly requests it by
+pressing an incomplete prefix key sequence. Unless this is zero,
+then the popup is shown after that many seconds of inactivity
+(using the absolute value).
+@end itemize
@end defopt
@defopt transient-display-buffer-action
diff --git a/lisp/transient.el b/lisp/transient.el
index d9b060bc41..69d1f04049 100644
--- a/lisp/transient.el
+++ b/lisp/transient.el
@@ -71,8 +71,8 @@
(defcustom transient-show-popup t
"Whether to show the current transient in a popup buffer.
-- If t, then show the popup as soon as a transient command is
- invoked.
+- If t, then show the popup as soon as a transient prefix command
+ is invoked.
- If nil, then do not show the popup unless the user explicitly
requests it, by pressing an incomplete prefix key sequence.
@@ -81,8 +81,8 @@
a brief one-line summary. If zero or negative, then suppress
even showing that summary and display the pressed key only.
- Show the when the user explicitly requests it by pressing an
- incomplete prefix key sequence. Unless zero, then also show
+ Show the popup when the user explicitly requests it by pressing
+ an incomplete prefix key sequence. Unless zero, then also show
the popup after that many seconds of inactivity (using the
absolute value)."
:package-version '(transient . "0.1.0")
