branch: externals/pulsar
commit 4781b670788329fe9bee8f4cc1f93fb645e89185
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Clarify statement in the documentation
---
README.org | 5 +++--
pulsar.el | 5 +++--
2 files changed, 6 insertions(+), 4 deletions(-)
diff --git a/README.org b/README.org
index 49e60cd873..3ca154acb1 100644
--- a/README.org
+++ b/README.org
@@ -79,8 +79,9 @@ enabled.
#+vindex: pulsar-face
The overall duration of the highlight is determined by a combination of
~pulsar-delay~ and ~pulsar-iterations~. The latter determines the
-number of blinks in a pulse, while the former sets their interval in
-seconds. The applicable face is specified in ~pulsar-face~.
+number of blinks in a pulse, while the former sets their delay in
+seconds before they fade out. The applicable face is specified in
+~pulsar-face~.
#+vindex: pulsar-pulse
To disable the pulse but keep the temporary highlight, set the user
diff --git a/pulsar.el b/pulsar.el
index 94529d4fb2..f447899217 100644
--- a/pulsar.el
+++ b/pulsar.el
@@ -33,8 +33,9 @@
;;
;; The overall duration of the highlight is determined by a combination
;; of `pulsar-delay' and `pulsar-iterations'. The latter determines the
-;; number of blinks in a pulse, while the former sets their interval in
-;; seconds. The applicable face is specified in `pulsar-face'.
+;; number of blinks in a pulse, while the former sets their delay in
+;; seconds before they fade out. The applicable face is specified in
+;; `pulsar-face'.
;;
;; To disable the pulse but keep the temporary highlight, set the user
;; option `pulsar-pulse' to nil. The current line will remain
