branch: elpa/fedi
commit 9f0c1ce722595d1c883534be0afafbc756e47813
Author: marty hiatt <[email protected]>
Commit: marty hiatt <[email protected]>
return capf docs
---
fedi-post.el | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/fedi-post.el b/fedi-post.el
index 44ae5535e30..4062ac11487 100644
--- a/fedi-post.el
+++ b/fedi-post.el
@@ -226,8 +226,13 @@ Buffer-local variable `fedi-post-previous-window-config'
holds the config."
annot-fun _affix-fun exit-fun)
"Return a completion at point function.
REGEX is used to get the item before point.
+
COMPLETION-FUN takes two args, start and end bounds of item
-before point, and returns a completion table.
+before point, and returns a completion table. Nota bene that for
+completion to work correctly, COMPLETION-FUN must return data
+containing candidates that will literally match the preceding
+search string, including any prefixes like @ or #.
+
ANNOT-FUN takes one arg, a candidate, and returns an annotation
for it.
AFFIX-FUN is currently unused, it would be :affixation-function.
