diff options
| author | Daniel Mendler <mail@daniel-mendler.de> | 2021-11-24 12:32:35 +0100 |
|---|---|---|
| committer | Daniel Mendler <mail@daniel-mendler.de> | 2021-11-24 12:32:35 +0100 |
| commit | 3eb7efc2d4ea49564a5b4f25b3d565d0b2a664ba (patch) | |
| tree | c251c38942acd0e9171935633ffb005f36ee7ed2 | |
| parent | dc26e9f7ab5f62f09c33a2f79c5cacfa5d95899b (diff) | |
README: Expand reasoning
| -rw-r--r-- | README.org | 15 |
1 files changed, 9 insertions, 6 deletions
@@ -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 |
