branch: externals/pulsar
commit 6e4157f4e30eca0c21f0960ec7cb2ad3ad64e7d9
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Document pulsar-pulse-region
---
README.org | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/README.org b/README.org
index 2dcda6d3d3..eb96b0da36 100644
--- a/README.org
+++ b/README.org
@@ -98,6 +98,13 @@ will pulse before fading away. Whereas the
~pulsar-highlight-line~
command never pulses the line: the highlight stays in place as if
~pulsar-pulse~ is nil.
+#+findex: pulsar-pulse-region
+The command ~pulsar-pulse-region~ pulses the active region. In case
+of multiple regions, it operates on the topmost one. The effect of
+the pulse is controlled by the aforementioned user options, namely,
+~pulsar-delay~, ~pulsar-iterations~, ~pulsar-face~. [ The command
+~pulsar-pulse-region~ is part of {{{development-version}}}. ]
+
#+findex: pulsar-highlight-dwim
A do-what-I-mean command is also on offer: ~pulsar-highlight-dwim~. It
highlights the current line line like ~pulsar-highlight-line~. If the
