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

Clarify the relation of Completion Preview mode with
'completion-at-point' and in-buffer completion interfaces.
This commit is contained in:
Eshel Yaron 2025-02-26 21:14:37 +01:00
parent 50cded9c55
commit 0285a403e3
No known key found for this signature in database
GPG key ID: EF3EE9CA35D78618

View file

@ -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