[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/corfu 4c2d5de 4/6: Update readme
From: |
Protesilaos Stavrou |
Subject: |
[elpa] externals/corfu 4c2d5de 4/6: Update readme |
Date: |
Sat, 17 Apr 2021 18:26:56 -0400 (EDT) |
branch: externals/corfu
commit 4c2d5de68352b9e1957b78768727fb72847c40ff
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
Update readme
---
README.org | 23 ++++++++++++-----------
corfu.el | 4 ++--
2 files changed, 14 insertions(+), 13 deletions(-)
diff --git a/README.org b/README.org
index 6d34893..6b2dd29 100644
--- a/README.org
+++ b/README.org
@@ -8,12 +8,12 @@
* Introduction
-Corfu provides a completion overlay for the default completion in region
-function. The current candidates are shown in a popup overlay below or above
the
+Corfu enhances the default completion in region function with a completion
+overlay. The current candidates are shown in a popup overlay below or above the
point. Corfu can be considered the minimalistic completion-in-region
counterpart
-of Vertico.
+of the [[https://github.com/minad/vertico][Vertico]] minibuffer UI.
-Icomplete provides both completion-in-region and minibuffer completion in a
+Icomplete implements both completion-in-region and minibuffer completion in a
single package. While Corfu and Vertico are technically similar to Icomplete,
Corfu and Vertico are two separate packages in order to optimize the UI for the
two distinct use cases, also leading to code bases which are easier to
@@ -21,11 +21,12 @@ understand.
Corfu is a minimal package of less than 500 lines of code (my arbitrary limit
for small components providing a single specific feature). In contrast to the
-featureful and complex Company package, Corfu only provides the completion
-UI. No custom backends are provided. The completions are provided by the
-~completion-at-point-functions~. However many code completion backends provide
-~completion-at-point-functions~, such that relying only on the default
-completion may often be sufficient.
+featureful and complex Company package, Corfu only provides the completion UI
+and does not include custom completion backends. Completions are generated by
+calling the ~completion-at-point-functions~ (Capfs). Many code completion
+backends provide such a Capf, such that relying only on the default completion
+is often sufficient. For example the language server packages,
[[https://github.com/joaotavora/eglot][Eglot]] and
+[[https://github.com/emacs-lsp/lsp-mode][Lsp-mode]], both implement a Capf.
[[https://github.com/minad/corfu/blob/main/screenshot.png?raw=true]]
@@ -100,8 +101,8 @@ Corfu works well together with all packages providing code
completion via the
styles, including the advanced
[[https://github.com/oantolin/orderless][Orderless]] completion style, where
the filtering
expressions are separated by spaces.
-You may also want to look into my
[[https://github.com/minad/vertico][Vertico]] package, which provides a vertical
-minibuffer completion system. Vertico is the minibuffer counterpart of Corfu.
+You may also want to look into my
[[https://github.com/minad/vertico][Vertico]] package. Vertico is the minibuffer
+counterpart of Corfu.
* Caveats
diff --git a/corfu.el b/corfu.el
index a873816..fc1fe29 100644
--- a/corfu.el
+++ b/corfu.el
@@ -26,8 +26,8 @@
;;; Commentary:
-;; Corfu provides a completion overlay for the default completion in
-;; region function. The current candidates are shown in a popup
+;; Corfu enhances the default completion in region function with a
+;; completion overlay. The current candidates are shown in a popup
;; overlay below or above the point. Corfu can be considered the
;; minimalistic completion-in-region counterpart of Vertico.
- [elpa] externals/corfu updated (4c2c997 -> 5214170), Protesilaos Stavrou, 2021/04/17
- [elpa] externals/corfu e226da3 1/6: Oops, use `:global nil` instead of `:local t`, Protesilaos Stavrou, 2021/04/17
- [elpa] externals/corfu 68d799a 2/6: Revert "Add corfu-completion-styles", Protesilaos Stavrou, 2021/04/17
- [elpa] externals/corfu 6c361fd 3/6: README: Update caveats section, Protesilaos Stavrou, 2021/04/17
- [elpa] externals/corfu 4c2d5de 4/6: Update readme,
Protesilaos Stavrou <=
- [elpa] externals/corfu 59263bf 5/6: Hide scrollbar if there are fewer than corfu-count candidates, Protesilaos Stavrou, 2021/04/17
- [elpa] externals/corfu 5214170 6/6: Add base string when previewing the current candidate, Protesilaos Stavrou, 2021/04/17