branch: elpa/evil-goggles
commit 90da624f368f4730a7ce8b3993f0d31baaea471d
Author: Evgeni Kolev <[email protected]>
Commit: Evgeni Kolev <[email protected]>
Improve docs
---
evil-goggles.el | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/evil-goggles.el b/evil-goggles.el
index 6761497944..e1772a440f 100644
--- a/evil-goggles.el
+++ b/evil-goggles.el
@@ -57,7 +57,7 @@ This option is experimental."
:group 'evil-goggles)
(defface evil-goggles--pulse-face nil
- "Temporary face used when pulsing.
+ "Temporary face used when pulsing, should not be modified.
This is needed because the pulse package expects to receive a face, it
can't work with input such as (backgound . \"red\")."
@@ -77,8 +77,8 @@ otherwise - a region."
(defun evil-goggles--show-region (beg end face)
"Show overlay in region from BEG to END with FACE.
-The overlay will either pulse if variable `evil-goggles-pulse' is t or
-appear and disappear."
+The overlay will pulse if variable `evil-goggles-pulse' is t,
+otherwise it will just appear and disappear."
(let ((ov (evil-goggles--make-overlay beg end))
(bg (evil-goggles--face-background face)))
(unwind-protect
