[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/helm cca6337c2c 2/3: Fix docstring
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/helm cca6337c2c 2/3: Fix docstring |
Date: |
Sat, 5 Aug 2023 12:59:43 -0400 (EDT) |
branch: elpa/helm
commit cca6337c2c90d1ecdee19e3381720f5cf2de5a6d
Author: Thierry Volpiatto <thievol@posteo.net>
Commit: Thierry Volpiatto <thievol@posteo.net>
Fix docstring
---
helm-mode.el | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/helm-mode.el b/helm-mode.el
index 2febd792b0..2d9ace5b66 100644
--- a/helm-mode.el
+++ b/helm-mode.el
@@ -1836,7 +1836,7 @@ The `helm-find-files' history `helm-ff-history' is used
here."
str))
(defun helm--symbol-completion-table-affixation (_completions)
- "Override advice for `help--symbol-completion-table-affixation'.
+ "Override `help--symbol-completion-table-affixation'.
Normally affixation functions use COMPLETIONS as arg, and return a list of
modified COMPLETIONS. Now we allow affixations functions to return a
@@ -1844,8 +1844,8 @@ function instead, just like annotation functions. The
function should return a
list of three elements like (comp prefix suffix). This increase significantly
the speed avoiding one useless loop on complete list of candidates.
-This advice is used in helm completion by `helm-mode'.
-It returns a function and not a list of completions.
+Returns a function and not a list of completions.
+
It affects actually describe-variable/function/command/symbol functions.
It uses `helm-get-first-line-documentation' which allow providing documentation
for `describe-variable' symbols and align properly documentation when helm
style