]> git.eshelyaron.com Git - emacs.git/commitdiff
; * lisp/completion-preview.el: Add some commentary.
authorEshel Yaron <me@eshelyaron.com>
Wed, 26 Feb 2025 20:14:37 +0000 (21:14 +0100)
committerEshel Yaron <me@eshelyaron.com>
Wed, 26 Feb 2025 20:14:37 +0000 (21:14 +0100)
Clarify the relation of Completion Preview mode with
'completion-at-point' and in-buffer completion interfaces.

lisp/completion-preview.el

index c6a541157a20e960a89ef474bad96c6de14730b9..68a898921a60e35bb572ff35d06346c3cc34aef1 100644 (file)
 ;; 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