From: Eshel Yaron <me@eshelyaron.com>
Date: Wed, 26 Feb 2025 20:14:37 +0000 (+0100)
Subject: ; * lisp/completion-preview.el: Add some commentary.
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=353a54f63361fe7394830de0a4645d340664764d;p=emacs.git

; * lisp/completion-preview.el: Add some commentary.

Clarify the relation of Completion Preview mode with
'completion-at-point' and in-buffer completion interfaces.
---

diff --git a/lisp/completion-preview.el b/lisp/completion-preview.el
index c6a541157a2..68a898921a6 100644
--- a/lisp/completion-preview.el
+++ b/lisp/completion-preview.el
@@ -32,6 +32,15 @@
 ;; the buffer.  Completion Preview mode continues to update the
 ;; suggestion as you type according to the text around point.
 ;;
+;; Completion Preview mode uses `completion-at-point-functions' to find
+;; relevant completion suggestions, similarly to `completion-at-point'.
+;; You can use `completion-at-point' with your favorite in-buffer
+;; completion interface together with Completion Preview mode, just
+;; invoke `completion-at-point' as usual when you want to see all
+;; currently available completions.  Another reason to invoke
+;; `completion-at-point' is when you want non-prefix completion, since
+;; Completion Preview mode only shows one prefix completion.
+;;
 ;; The commands `completion-preview-next-candidate' and
 ;; `completion-preview-prev-candidate' allow you to cycle the
 ;; completion candidate that the preview suggests.  These commands