[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/cape 3eb7efc2d4 050/146: README: Expand reasoning
From: |
ELPA Syncer |
Subject: |
[elpa] externals/cape 3eb7efc2d4 050/146: README: Expand reasoning |
Date: |
Sun, 9 Jan 2022 20:57:41 -0500 (EST) |
branch: externals/cape
commit 3eb7efc2d4ea49564a5b4f25b3d565d0b2a664ba
Author: Daniel Mendler <mail@daniel-mendler.de>
Commit: Daniel Mendler <mail@daniel-mendler.de>
README: Expand reasoning
---
README.org | 15 +++++++++------
1 file changed, 9 insertions(+), 6 deletions(-)
diff --git a/README.org b/README.org
index a8db5d7845..e15d789af0 100644
--- a/README.org
+++ b/README.org
@@ -69,10 +69,11 @@ this package should be upstreamed into Emacs itself.
Cape provides an adapter for Company backends ~cape-company-to-capf~. The
adapter
transforms Company backends to Capfs which are understood by the built-in Emacs
-completion mechanism. The adapter is still experimental and may have certain
-edge cases. In particular, asynchronous completions are forcibly synchronized,
-but we are investigating possible Capf extensions to support asynchronous
Capfs.
-The adapter can be used as follows:
+completion mechanism. The function is approximately the inverse of the
+~company-capf~ backend from Company. The adapter is still experimental and may
+have certain edge cases. In particular, asynchronous completions are forcibly
+synchronized, but we are investigating possible Capf extensions to support
+asynchronous Capfs. The adapter can be used as follows:
#+begin_src emacs-lisp
;; Use Company backends as Capfs.
@@ -101,11 +102,13 @@ merging in the future.
/The Capf-Buster ensures that you always get a fresh set of candidates!/
-If a Capf caches the candidates too aggressively we can use a cache busting
+If a Capf caches the candidates for too long we can use a cache busting
Capf-transformer. For example the Capf merging function ~cape-super-capf~
creates
a Capf, which caches the candidates for the whole lifetime of the Capf.
Therefore you may want to combine a merged Capf with a cache buster under some
-circumstances.
+circumstances. It is noteworthy that the ~company-capf~ backend from Company
+refreshes the completion table frequently. With the ~cape-capf-buster~ we can
+achieve a similarly refreshing strategy.
#+begin_src emacs-lisp
(setq-local completion-at-point-functions
- [elpa] externals/cape d3e4d152ac 024/146: Add cape-symbol, (continued)
- [elpa] externals/cape d3e4d152ac 024/146: Add cape-symbol, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 8036636a0f 026/146: Add comment, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 9bd7bed258 029/146: cape-company-capf: Call the backend later in the completion process, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 67c3b75e2a 039/146: Refactor dabbrev, simplify, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 6e525cdfdd 040/146: Rework cape-company-to-capf, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 6deb7d7a8b 044/146: Add docstrings, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 3ad6aa105e 045/146: cape-company-to-capf: Simplify, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 4a1f19af23 057/146: Fix super capf, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 26401bfa6a 069/146: Unify cape-abbrev and cape-abbrev-capf, ELPA Syncer, 2022/01/09
- [elpa] externals/cape d265a03e7f 074/146: cape-dabbrev: Make interactive, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 3eb7efc2d4 050/146: README: Expand reasoning,
ELPA Syncer <=
- [elpa] externals/cape 8cf2942881 085/146: Add comments regarding interruptible completion tables, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 488cfd9ed7 086/146: Move code around, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 2008d809b6 088/146: Add cape-capf-with-predicate, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 4b424150ef 090/146: cape-super-capf: Delete duplicates (Fix #13), ELPA Syncer, 2022/01/09
- [elpa] externals/cape da32e232d6 093/146: cape--company-call: Cheaper timeout checking, throw error, ELPA Syncer, 2022/01/09
- [elpa] externals/cape c4d821d55b 079/146: Add cape--symbol-annotation, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 2ce63259d7 097/146: Update README - Asynchronous Company backends work as expected, ELPA Syncer, 2022/01/09
- [elpa] externals/cape c1f7fa746b 104/146: Improve synchronization, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 1d69a06890 117/146: cape-tex/cape-sgml: Add autoloads, ELPA Syncer, 2022/01/09
- [elpa] externals/cape 7f11b354df 124/146: cape-company-capf: Remove symbol restriction, ELPA Syncer, 2022/01/09