diff options
| author | Daniel Mendler <mail@daniel-mendler.de> | 2024-01-20 09:14:48 +0100 |
|---|---|---|
| committer | Daniel Mendler <mail@daniel-mendler.de> | 2024-01-20 09:14:48 +0100 |
| commit | b8b8e227d42229eca87189deb4f4157a49d5f819 (patch) | |
| tree | eaf1ec4b50a2265e7de12172b18ada1cef2b3352 | |
| parent | 21e44fee862c96cd169ab715f0fb1e041c83afa0 (diff) | |
Update README
| -rw-r--r-- | README.org | 32 |
1 files changed, 16 insertions, 16 deletions
@@ -195,23 +195,23 @@ with ~cape-capf-super~. Cape supports merging multiple Capfs using the function ~cape-capf-super~. This feature is *EXPERIMENTAL* and should only be used carefully in special scenarios. -Due to some technical details, only a subset of Capfs can be merged. Merge Capfs -one by one and make sure that you get the desired outcome on each step. - -Note that ~cape-capf-super~ is not needed if you want to use multiple Capfs which -are tried one after the other, for example you can use ~cape-file~ together with -programming mode Capfs by adding ~cape-file~ to the ~completion-at-point-functions~ -list. File completion will then be available in comments and string literals, -but not in normal code. ~cape-capf-super~ is only necessary if you want to combine -multiple Capfs, such that the candidates from multiple sources appear /together/ -in the completion list at the same time. - -Capf merging works only for completion functions which are sufficiently -well-behaved and completion functions which do not define completion boundaries. +Due to some technical details, not all Capfs can be merged successfully. Merge +Capfs one by one and make sure that you get the desired outcome. + +Note that ~cape-capf-super~ is not needed if multiple Capfs should betried one +after the other, for example you can use ~cape-file~ together with programming +mode Capfs by adding ~cape-file~ to the ~completion-at-point-functions~ list. File +completion will then be available in comments and string literals, but not in +normal code. ~cape-capf-super~ is only necessary if you want to combine multiple +Capfs, such that the candidates from multiple sources appear /together/ in the +completion list at the same time. + +Capf merging requires completion functions which are sufficiently well-behaved +and completion functions which do not define completion boundaries. ~cape-capf-super~ has the same restrictions as ~completion-table-merge~ and -~completion-table-in-turn~. As a simple rule of thumb, ~cape-capf-super~ works only -for static completion functions like ~cape-dabbrev~, ~cape-keyword~, ~cape-dict~, -etc., but not for multi-step completions like ~cape-file~. +~completion-table-in-turn~. As a simple rule of thumb, ~cape-capf-super~ works for +static completion functions like ~cape-dabbrev~, ~cape-keyword~, ~cape-dict~, etc., +but not for multi-step completions like ~cape-file~. #+begin_src emacs-lisp ;; Merge the dabbrev, dict and keyword capfs, display candidates together. |
