diff options
| author | Daniel Mendler <mail@daniel-mendler.de> | 2023-04-28 08:49:51 +0200 |
|---|---|---|
| committer | Daniel Mendler <mail@daniel-mendler.de> | 2023-04-28 08:51:24 +0200 |
| commit | e093bcd6f6c0cd659a824188a4cbbc3736876ef7 (patch) | |
| tree | eb1375d5b387a0c694164b8ab0e00410320ddb21 /README.org | |
| parent | 00cca1f1d082b8d904c78f47154bfd4aab72a7b7 (diff) | |
Clarify README
Diffstat (limited to 'README.org')
| -rw-r--r-- | README.org | 28 |
1 files changed, 16 insertions, 12 deletions
@@ -1,4 +1,4 @@ -#+title: corfu.el - Completion Overlay Region FUnction +#+title: corfu.el - COmpletion in Region FUnction #+author: Daniel Mendler #+language: en #+export_file_name: corfu.texi @@ -10,19 +10,23 @@ #+html: <a href="https://elpa.gnu.org/packages/corfu.html"><img alt="GNU ELPA" src="https://elpa.gnu.org/packages/corfu.svg"/></a> #+html: <a href="https://elpa.gnu.org/devel/corfu.html"><img alt="GNU-devel ELPA" src="https://elpa.gnu.org/devel/corfu.svg"/></a> -Corfu enhances completion at point with a small completion popup. The current -candidates are shown in a popup below or above the point. Corfu is the -minimalistic ~completion-in-region~ counterpart of the [[https://github.com/minad/vertico][Vertico]] minibuffer UI. +Corfu enhances in-buffer completion with a small completion popup. The current +candidates are shown in a popup below or above the point. The candidates can be +selected by moving up and down. Corfu is the minimalistic in-buffer completion +counterpart of the [[https://github.com/minad/vertico][Vertico]] minibuffer UI. Corfu is a small package, which relies on the Emacs completion facilities and -concentrates on providing a polished completion UI. Completions are either -provided by commands like ~dabbrev-completion~ or by pluggable backends -(~completion-at-point-functions~, Capfs). Most programming language major modes -implement a Capf. The Emacs language server clients use Capfs, which retrieve -completions from the server via the language server protocol (LSP). Corfu does -not include its own completion backends. The Emacs built-in Capfs and the Capfs -provided by other programming language packages are usually sufficient. A few -additional Capfs and completion utilities are provided by the [[https://github.com/minad/cape][Cape]] package. +concentrates on providing a polished completion UI. In-buffer completion UIs in +Emacs can hook into ~completion-in-region~, which implements the interaction with +the user. Completions at point are either provided by commands like +~dabbrev-completion~ or by pluggable backends (~completion-at-point-functions~, +Capfs) and are then passed to ~completion-in-region~. Most programming language +major modes implement a Capf. The Emacs language server clients use Capfs, which +retrieve completions from the server via the language server protocol (LSP). +Corfu does not include its own completion backends. The Emacs built-in Capfs and +the Capfs provided by other programming language packages are usually +sufficient. A few additional Capfs and completion utilities are provided by the +[[https://github.com/minad/cape][Cape]] package. *NOTE*: Corfu uses child frames to show the popup and falls back to the default setting of the ~completion-in-region-function~ on non-graphical displays. If you |
