emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/embark e1a0422cca: Mention embark--unmark-target in the


From: ELPA Syncer
Subject: [elpa] externals/embark e1a0422cca: Mention embark--unmark-target in the manual
Date: Thu, 30 Dec 2021 22:57:26 -0500 (EST)

branch: externals/embark
commit e1a0422cca599be81084cee35681601a5503c359
Author: Omar Antolín <omar.antolin@gmail.com>
Commit: Omar Antolín <omar.antolin@gmail.com>

    Mention embark--unmark-target in the manual
---
 README.org  | 11 +++++++++++
 embark.texi | 12 ++++++++++++
 2 files changed, 23 insertions(+)

diff --git a/README.org b/README.org
index 19cf043693..fecf8c7011 100644
--- a/README.org
+++ b/README.org
@@ -508,6 +508,17 @@ For pre-action hooks:
   s-expression targets, or for =fill-region= so that it works on
   paragraph targets.
 
+- =embark--unmark-target= :: Unmark the active region. Use this for
+  commands you want to act on the region contents but without the
+  region being active. The default configuration uses this function as
+  a pre-action hook for =occur= and =query-replace=, for example, so that
+  you can use them as actions with region targets to search the whole
+  buffer for the text contained in the region. Without this pre-action
+  hook using =occur= as an action for a region target would be
+  pointless: it would search for the the region contents /in the
+  region/, (typically, due to the details of regexps) finding only one
+  match!
+
 - =embark--beginning-of-target= :: Move to the beginning of the target
   (for targets that report bounds). This is used by default for
   backward motion commands such as =backward-sexp=, so that they don't
diff --git a/embark.texi b/embark.texi
index 12ac55eea8..c3e945d92d 100644
--- a/embark.texi
+++ b/embark.texi
@@ -632,6 +632,18 @@ example, it is used by default for @samp{indent-region} so 
that it works on
 s-expression targets, or for @samp{fill-region} so that it works on
 paragraph targets.
 
+@item @samp{embark--unmark-target}
+Unmark the active region. Use this for
+commands you want to act on the region contents but without the
+region being active. The default configuration uses this function as
+a pre-action hook for @samp{occur} and @samp{query-replace}, for example, so 
that
+you can use them as actions with region targets to search the whole
+buffer for the text contained in the region. Without this pre-action
+hook using @samp{occur} as an action for a region target would be
+pointless: it would search for the the region contents @emph{in the
+region}, (typically, due to the details of regexps) finding only one
+match!
+
 @item @samp{embark--beginning-of-target}
 Move to the beginning of the target
 (for targets that report bounds). This is used by default for



reply via email to

[Prev in Thread] Current Thread [Next in Thread]