[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/corfu 6c361fd 3/6: README: Update caveats section
From: |
Protesilaos Stavrou |
Subject: |
[elpa] externals/corfu 6c361fd 3/6: README: Update caveats section |
Date: |
Sat, 17 Apr 2021 18:26:56 -0400 (EDT) |
branch: externals/corfu
commit 6c361fd88b233cd867c5ac94680384bff53c64ce
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
README: Update caveats section
---
README.org | 19 +++++++++----------
1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/README.org b/README.org
index eb675fd..6d34893 100644
--- a/README.org
+++ b/README.org
@@ -106,19 +106,18 @@ minibuffer completion system. Vertico is the minibuffer
counterpart of Corfu.
* Caveats
This package is experimental and new. I am not yet claiming that this package
-works correctly. There are a few known caveats.
+works correctly. There are a few known technical caveats.
-- No caching, the completion table is called directly.
-- The =:exit-function= handling is probably insufficient.
-- The overlay popup is brittle (Alternatives: Posframe, Postip?)
+- No additional caching, the completion table is called repeatedly.
+- The =:exit-function= is always called with argument =finished= after
insertion.
+- The overlay popup is brittle (Alternatives to consider: Posframe, Postip)
- The thin popup borders are only drawn if =line-spacing=nil=.
-- The abort handling could be improved. Undo the completion input?
-- The ~completion-in-region-mode-predicate~ is deliberatly ignored in order to
- give the completion style full control. This predicate checks if the start
- position of the completion changed by calling the backend.
+- The abort handling could be improved, for example the input could be undone.
+- The ~completion-in-region-mode-predicate~ is ignored in order to
+ give the completion style full control. The predicate asks the backend if
+ if the starting point of the completion changed.
- Completion is terminated if there are no matches. Add optional confirmation?
-- Company kind icons are not supported (~company-kind~)
-- Company metadata is not shown (~company-docsig~)
+- Company kind icons and metadata are not supported (~company-kind~,
~company-docsig~)
* Contributions
- [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 <=
- [elpa] externals/corfu 4c2d5de 4/6: Update readme, Protesilaos Stavrou, 2021/04/17
- [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