[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/embark 589b057d00 4/4: Update documentation for revert
From: |
ELPA Syncer |
Subject: |
[elpa] externals/embark 589b057d00 4/4: Update documentation for revert --> rerun switch |
Date: |
Fri, 23 Dec 2022 17:57:39 -0500 (EST) |
branch: externals/embark
commit 589b057d0003af99d376462531d2d4453439da52
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>
Update documentation for revert --> rerun switch
---
README.org | 27 ++++++++++++++-------------
embark.el | 35 +++++++++++++++++++----------------
2 files changed, 33 insertions(+), 29 deletions(-)
diff --git a/README.org b/README.org
index 7edf270e19..8a94f9db97 100644
--- a/README.org
+++ b/README.org
@@ -208,14 +208,14 @@ and are bound to =A=, =S= (for "snapshot"), and =E=,
respectively, in
key bindings for these (although you can, of course!), just a key
binding for =embark-act=.
-Reverting an Embark Collect or Embark Export buffer has slightly
-unusual behavior if the buffer was obtained by running =embark-collect=
-or =embark-export= from within a minibuffer completion session. In that
-case reverting just restarts the completion session, that is, the
-command that opened the minibuffer is run again and the minibuffer
-contents restored. You can then interact normally with the command,
-perhaps editing the minibuffer contents, and, if you wish, you can
-rerun =embark-collect= or =embark-export= to get an updated buffer.
+In Embark Collect or Embark Export buffers that were obtained by
+running =embark-collect= or =embark-export= from within a minibuffer
+completion session, =g= is bound to a command that restarts the
+completion session, that is, the command that opened the minibuffer is
+run again and the minibuffer contents restored. You can then interact
+normally with the command, perhaps editing the minibuffer contents,
+and, if you wish, you can rerun =embark-collect= or =embark-export= to get
+an updated buffer.
*** =embark-live= a live-updating variant of =embark-collect=
@@ -990,11 +990,12 @@ The =embark-consult= package provides the following
exporters:
to navigate among matches, and, if you install the
[[http://github.com/mhayashi1120/Emacs-wgrep/raw/master/wgrep.el ][wgrep]]
package,
you can use it to edit the matches in place.
-In both cases, pressing =g= to revert the exported buffer will rerun the
-Consult command you had exported from and re-enter the input you had
-typed. You can then proceed to re-export if that's what you want, but
-you can also edit the input changing the search terms or simply cancel
-if you see you are done with that search.
+In both cases, pressing =g= will rerun the Consult command you had
+exported from and re-enter the input you had typed (which is similar
+to reverting but a little more flexible). You can then proceed to
+re-export if that's what you want, but you can also edit the input
+changing the search terms or simply cancel if you see you are done
+with that search.
The =embark-consult= also contains some candidates collectors that allow
you to run =embark-live= to get a live-updating table of contents for
diff --git a/embark.el b/embark.el
index 414cf23e33..3cdf157366 100644
--- a/embark.el
+++ b/embark.el
@@ -3027,14 +3027,15 @@ TYPE should be either `collect' or `export'."
To control the display, add an entry to `display-buffer-alist'
with key \"Embark Collect\".
-Reverting an Embark Collect buffer has slightly unusual behavior
-if the buffer was obtained by running `embark-collect' from
-within a minibuffer completion session. In that case reverting
-just restarts the completion session, that is, the command that
-opened the minibuffer is run again and the minibuffer contents
-restored. You can then interact normally with the command,
-perhaps editing the minibuffer contents, and, if you wish, you
-can rerun `embark-collect' to get an updated buffer."
+In Embark Collect buffers `revert-buffer' is remapped to
+`embark-rerun-collect-or-export', which has slightly unusual
+behavior if the buffer was obtained by running `embark-collect'
+from within a minibuffer completion session. In that case
+rerunning just restarts the completion session, that is, the
+command that opened the minibuffer is run again and the
+minibuffer contents restored. You can then interact normally with
+the command, perhaps editing the minibuffer contents, and, if you
+wish, you can rerun `embark-collect' to get an updated buffer."
(interactive)
(let ((buffer (embark--collect (embark--descriptive-buffer-name 'collect))))
(when (minibufferp)
@@ -3115,14 +3116,16 @@ The parameter KIND should be either `embark-export' or
`embark-collect'."
The variable `embark-exporters-alist' controls how to make the
buffer for each type of completion.
-Reverting an Embark Export buffer has slightly unusual behavior if
-the buffer was obtained by running `embark-export' from within a
-minibuffer completion session. In that case reverting just
-restarts the completion session, that is, the command that opened
-the minibuffer is run again and the minibuffer contents restored.
-You can then interact normally with the command, perhaps editing
-the minibuffer contents, and, if you wish, you can rerun
-`embark-export' to get an updated buffer."
+In Embark Export buffers `revert-buffer' is remapped to
+`embark-rerun-collect-or-export', which has slightly unusual
+behavior if the buffer was obtained by running `embark-export'
+from within a minibuffer completion session. In that case
+reverting just restarts the completion session, that is, the
+command that opened the minibuffer is run again and the
+minibuffer contents restored. You can then interact normally
+with the command, perhaps editing the minibuffer contents, and,
+if you wish, you can rerun `embark-export' to get an updated
+buffer."
(interactive)
(let* ((transformed (embark--maybe-transform-candidates))
(candidates (or (plist-get transformed :candidates)