[elpa] externals/pulsar b549ce31b3 4/9: Document pulsar-pulse-on-window-change

[ELPA Syncer]

branch: externals/pulsar
commit b549ce31b34f5619cad42a70d133921b74d0b70f
Author: Protesilaos Stavrou <info@protesilaos.com>
Commit: Protesilaos Stavrou <info@protesilaos.com>

    Document pulsar-pulse-on-window-change
---
 README.org | 43 +++++++++++++++++++++++++------------------
 1 file changed, 25 insertions(+), 18 deletions(-)

diff --git a/README.org b/README.org
index 85cb2a11d0..86d0f242ae 100644
--- a/README.org
+++ b/README.org
@@ -72,6 +72,11 @@ in the user option ~pulsar-pulse-functions~ and the effect 
takes place
 when either ~pulsar-mode~ (buffer-local) or ~pulsar-global-mode~ is
 enabled.
 
+There is no need to add all functions that affect the active window to
+the ~pulsar-pulse-functions~.  Instead, set the user option
+~pulsar-pulse-on-window-change~ to a non-nil value.  It will pulse the
+current line whenever the active window changes (it is part of
+{{{development-version}}}).
 
 #+vindex: pulsar-delay
 #+vindex: pulsar-iterations
@@ -173,30 +178,31 @@ Remember to read the doc string of each of these 
variables.
 (require 'pulsar)
 
 (setq pulsar-pulse-functions
-      '(isearch-repeat-forward
-        isearch-repeat-backward
-        recenter-top-bottom
+      ;; NOTE 2022-04-09: The commented out functions are from before
+      ;; the introduction of `pulsar-pulse-on-window-change'.  Try that
+      ;; instead.
+      '(recenter-top-bottom
         move-to-window-line-top-bottom
         reposition-window
-        bookmark-jump
-        other-window
-        delete-window
-        delete-other-windows
+        ;; bookmark-jump
+        ;; other-window
+        ;; delete-window
+        ;; delete-other-windows
         forward-page
         backward-page
         scroll-up-command
         scroll-down-command
-        windmove-right
-        windmove-left
-        windmove-up
-        windmove-down
-        windmove-swap-states-right
-        windmove-swap-states-left
-        windmove-swap-states-up
-        windmove-swap-states-down
-        tab-new
-        tab-close
-        tab-next
+        ;; windmove-right
+        ;; windmove-left
+        ;; windmove-up
+        ;; windmove-down
+        ;; windmove-swap-states-right
+        ;; windmove-swap-states-left
+        ;; windmove-swap-states-up
+        ;; windmove-swap-states-down
+        ;; tab-new
+        ;; tab-close
+        ;; tab-next
         org-next-visible-heading
         org-previous-visible-heading
         org-forward-heading-same-level
@@ -207,6 +213,7 @@ Remember to read the doc string of each of these variables.
         outline-previous-visible-heading
         outline-up-heading))
 
+(setq pulsar-pulse-on-window-change t)
 (setq pulsar-pulse t)
 (setq pulsar-delay 0.055)
 (setq pulsar-iterations 10)