diff options
| author | Eshel Yaron | 2025-02-26 21:14:37 +0100 |
|---|---|---|
| committer | Eshel Yaron | 2025-02-26 21:19:58 +0100 |
| commit | 0285a403e339bc5973f220a5f8a9693a359fe7ca (patch) | |
| tree | e27dca8171b3641cd9799cf1ff9d08364aa03401 /lisp/completion-preview.el | |
| parent | 50cded9c5502f34218873b762066a03682075222 (diff) | |
| download | emacs-0285a403e339bc5973f220a5f8a9693a359fe7ca.tar.gz emacs-0285a403e339bc5973f220a5f8a9693a359fe7ca.zip | |
; * lisp/completion-preview.el: Add some commentary.
Clarify the relation of Completion Preview mode with
'completion-at-point' and in-buffer completion interfaces.
Diffstat (limited to 'lisp/completion-preview.el')
| -rw-r--r-- | lisp/completion-preview.el | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/lisp/completion-preview.el b/lisp/completion-preview.el index 2fe336c0a73..4fc9bb0c9f3 100644 --- a/lisp/completion-preview.el +++ b/lisp/completion-preview.el | |||
| @@ -32,6 +32,15 @@ | |||
| 32 | ;; the buffer. Completion Preview mode continues to update the | 32 | ;; the buffer. Completion Preview mode continues to update the |
| 33 | ;; suggestion as you type according to the text around point. | 33 | ;; suggestion as you type according to the text around point. |
| 34 | ;; | 34 | ;; |
| 35 | ;; Completion Preview mode uses `completion-at-point-functions' to find | ||
| 36 | ;; relevant completion suggestions, similarly to `completion-at-point'. | ||
| 37 | ;; You can use `completion-at-point' with your favorite in-buffer | ||
| 38 | ;; completion interface together with Completion Preview mode, just | ||
| 39 | ;; invoke `completion-at-point' as usual when you want to see all | ||
| 40 | ;; currently available completions. Another reason to invoke | ||
| 41 | ;; `completion-at-point' is when you want non-prefix completion, since | ||
| 42 | ;; Completion Preview mode only shows one prefix completion. | ||
| 43 | ;; | ||
| 35 | ;; The commands `completion-preview-next-candidate' and | 44 | ;; The commands `completion-preview-next-candidate' and |
| 36 | ;; `completion-preview-prev-candidate' allow you to cycle the | 45 | ;; `completion-preview-prev-candidate' allow you to cycle the |
| 37 | ;; completion candidate that the preview suggests. These commands | 46 | ;; completion candidate that the preview suggests. These commands |