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

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

[nongnu] elpa/idle-highlight-mode ee5381764c 51/59: Add docstrings


From: ELPA Syncer
Subject: [nongnu] elpa/idle-highlight-mode ee5381764c 51/59: Add docstrings
Date: Thu, 7 Jul 2022 12:00:32 -0400 (EDT)

branch: elpa/idle-highlight-mode
commit ee5381764c28c9291fd6882f0879f453a074c218
Author: Campbell Barton <ideasman42@gmail.com>
Commit: Campbell Barton <ideasman42@gmail.com>

    Add docstrings
---
 idle-highlight-mode.el | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/idle-highlight-mode.el b/idle-highlight-mode.el
index 93fb56b481..62e9ee55c7 100755
--- a/idle-highlight-mode.el
+++ b/idle-highlight-mode.el
@@ -257,6 +257,7 @@ Argument VISIBLE-RANGES is a list of (min . max) ranges to 
highlight."
                   (push ov idle-highlight--overlays))))))))))
 
 (defun idle-highlight--word-at-point-args ()
+  "Return arguments for `idle-highlight--highlight'."
   (when (idle-highlight--check-symbol-at-point (point))
     (let ((target-range (bounds-of-thing-at-point 'symbol)))
       (when (and target-range (idle-highlight--check-faces-at-point (point)))
@@ -266,7 +267,10 @@ Argument VISIBLE-RANGES is a list of (min . max) ranges to 
highlight."
               (cons target target-range))))))))
 
 (defun idle-highlight--word-at-point-highlight (target target-range 
visible-ranges)
-  "Highlight the word under the point across all VISIBLE-RANGES."
+  "Highlight the word under the point across all VISIBLE-RANGES.
+
+Arguments TARGET and TARGET-RANGE
+should be the result of `idle-highlight--word-at-point-args'."
   (idle-highlight--unhighlight)
   (when target
     (pcase-let ((`(,target-beg . ,target-end) target-range))



reply via email to

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