[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/helm bb5add845c 3/4: Update docstrings
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/helm bb5add845c 3/4: Update docstrings |
Date: |
Sat, 3 Sep 2022 02:58:52 -0400 (EDT) |
branch: elpa/helm
commit bb5add845c310b986fd5fc92532920f56e17d8b0
Author: Thierry Volpiatto <thievol@posteo.net>
Commit: Thierry Volpiatto <thievol@posteo.net>
Update docstrings
---
helm-utils.el | 12 ++++++++++--
1 file changed, 10 insertions(+), 2 deletions(-)
diff --git a/helm-utils.el b/helm-utils.el
index 544cd1fba2..9f7b1f164b 100644
--- a/helm-utils.el
+++ b/helm-utils.el
@@ -88,7 +88,8 @@ Possible value are:
(const :tag "Never match" never)))
(defcustom helm-highlight-only-all-matches nil
- "If t only highlight if all items matched on the line"
+ "Highlight only when all items match on the line when non nil.
+See `helm-highlight-current-line'."
:group 'helm-utils
:type 'boolean)
@@ -825,7 +826,14 @@ Inlined here for compatibility."
(defvar helm--match-item-overlays nil)
(cl-defun helm-highlight-current-line (&optional start end buf face)
- "Highlight and underline current position"
+ "Highlight current line and all matching items around it.
+
+The number of lines around matched line where the matching items are
+highlighted are defined by `helm-highlight-matches-around-point-max-lines'.
+When the variable `helm-highlight-only-all-matches' is non nil only
+the lines containing all matches (in case of multi match) are highlighted.
+
+Optional arguments START, END and FACE are only here for debugging purpose."
(let* ((start (or start (line-beginning-position)))
(end (or end (1+ (line-end-position))))
start-match end-match