branch: externals/cape
commit 2b9b3885522a670b5da290e5138824f52f1ca200
Author: Daniel Mendler <m...@daniel-mendler.de>
Commit: Daniel Mendler <m...@daniel-mendler.de>
Update readme
---
README.org | 5 +++--
1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/README.org b/README.org
index 64830585ea..64039582d4 100644
--- a/README.org
+++ b/README.org
@@ -63,7 +63,8 @@ Furthermore the =cape-*= functions are Capfs which you can
add to the
=completion-at-point-functions= list. Take care when adding Capfs to the list
since each of the Capfs adds a small runtime cost. Note that the Capfs which
occur earlier in the list take precedence, such that the first Capf returning a
-result will win and the later Capfs may not get a chance to run.
+result will win and the later Capfs may not get a chance to run. In order to
+merge Capfs you can try the experimental function =cape-super-capf=.
One must distinguish the buffer-local and the global value of the
=completion-at-point-functions= variable. The buffer-local value of the list
takes
@@ -189,7 +190,7 @@ then be used as a Capf via ~cape-company-to-capf~.
/Throw multiple Capfs under the Cape and get a Super-Capf!/
Cape supports merging multiple Capfs using the function ~cape-super-capf~.
-*This feature is EXPERIMENTAL and should only be used in special scenarios.
Don't use cape-super-capf if you are not 100% sure that you need it! If you
decide to use the function, you are on UNSUPPORTED TERRITORY.*
+*This feature is EXPERIMENTAL and should only be used carefully in special
scenarios. Due to some technical details, not all Capfs can be merged. Add
Capfs one by one and make sure that you get the desired outcome.*
Note that ~cape-super-capf~ is not needed if you want to use multiple Capfs
which
are tried one by one, e.g., it is perfectly possible to use ~cape-file~
together
