summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Mendler <mail@daniel-mendler.de>2021-11-27 12:23:55 +0100
committerDaniel Mendler <mail@daniel-mendler.de>2021-11-27 12:23:55 +0100
commit67d3d42c9e5924a9c2203a979f464acadac0442c (patch)
tree5a5d2de93ed586edb180aa75cd73fbe8cd3deff0
parent4a55d2b4a9442b0d0c8afa41e0af4d1b178772f5 (diff)
Update README
-rw-r--r--README.org15
1 files changed, 9 insertions, 6 deletions
diff --git a/README.org b/README.org
index f26d5e8..204caec 100644
--- a/README.org
+++ b/README.org
@@ -30,8 +30,9 @@
sufficient, but a few additional Capfs and completion functions are provided
by the [[https://github.com/minad/cape][Cape]] package.
- *NOTE*: Corfu uses child frames to show the popup; on non-graphical displays it
- will fall back to the default setting of the ~completion-in-region-function~.
+ *NOTE*: Corfu uses child frames to show the popup. For now Corfu falls back to
+ the default setting of the ~completion-in-region-function~ on non-graphical
+ displays. You may want to use ~consult-completion-in-region~.
[[https://github.com/minad/corfu/blob/screenshots/light.png?raw=true]]
@@ -195,15 +196,17 @@ moves to the next candidate and further input will then commit the selection.
Corfu is robust in most scenarios. There are a few known technical caveats.
- - Corfu falls back to the default Completion buffer on non-graphical displays,
- since Corfu requires child frames.
+ - Corfu uses child frames to show the popup. For now Corfu falls back to the
+ default setting of the ~completion-in-region-function~ on non-graphical
+ displays. You may want to use ~consult-completion-in-region~.
- No sorting by history, since ~completion-at-point~ does not
maintain a history (See branch =history= for a possible solution).
- There is currently no equivalent for =company-quickhelp=. Documentation and source
can be opened manually in a separate buffer.
- Company has the ability to merge/group the candidates of multiple backends
- in some scenarios. This feature is implemented by the function
- ~cape-super-capf~ of the [[https://github.com/minad/cape][Cape]] package.
+ in some scenarios. Merging multiple backends is not directly supported by
+ the ~completion-at-point-functions~. The [[https://github.com/minad/cape][Cape]] package provides the function
+ ~cape-super-capf~ which can merge multiple Capfs.
* Contributions