summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--CHANGELOG.org2
-rw-r--r--README.org18
-rw-r--r--cape.el5
3 files changed, 15 insertions, 10 deletions
diff --git a/CHANGELOG.org b/CHANGELOG.org
index 86789d8..d9bf74c 100644
--- a/CHANGELOG.org
+++ b/CHANGELOG.org
@@ -12,6 +12,8 @@
- =cape-capf-inside-faces=, =cape-wrap-inside-faces=: New transformer
- Rename =cape-super-capf= to =cape-capf-super=. Add =cape-wrap-super= for consistency
with other Capf combinators.
+- Rename =cape-interactive-capf= to =cape-capf-interactive= for consistency with
+ other Capf combinators.
- Rename =cape-symbol= to =cape-elisp-symbol=.
* Version 0.17 (2023-08-14)
diff --git a/README.org b/README.org
index 87dc824..05e4b55 100644
--- a/README.org
+++ b/README.org
@@ -252,22 +252,22 @@ interaction. These can either be used as advices (=cape-wrap-*)= or to create a
new Capf from an existing Capf (=cape-capf-*=). You can bind the Capfs created by
the Capf transformers with =defalias= to a function symbol.
-- ~cape-interactive-capf~, ~cape-interactive~: Create a Capf which can be called interactively.
+- ~cape-capf-interactive~, ~cape-interactive~: Create a Capf which can be called interactively.
- ~cape-wrap-accept-all~, ~cape-capf-accept-all~: Create a Capf which accepts every input as valid.
+- ~cape-wrap-case-fold~, ~cape-capf-case-fold~: Create a Capf which is case insensitive.
- ~cape-wrap-debug~, ~cape-capf-debug~: Create a Capf which prints debugging messages.
-- ~cape-wrap-silent~, ~cape-capf-silent~: Wrap a chatty Capf and silence it.
-- ~cape-wrap-purify~, ~cape-capf-purify~: Purify a broken Capf and ensure that it does not modify the buffer.
+- ~cape-wrap-inside-comment~, ~cape-capf-inside-comment~: Ensure that Capf triggers only inside comment.
+- ~cape-wrap-inside-faces~, ~cape-capf-inside-faces~: Ensure that Capf triggers only inside text with certain faces.
+- ~cape-wrap-inside-string~, ~cape-capf-inside-string~: Ensure that Capf triggers only inside a string literal.
- ~cape-wrap-nonexclusive~, ~cape-capf-nonexclusive:~ Mark Capf as non-exclusive.
- ~cape-wrap-noninterruptible~, ~cape-capf-noninterruptible:~ Protect a Capf which does not like to be interrupted.
-- ~cape-wrap-case-fold~, ~cape-capf-case-fold~: Create a Capf which is case insensitive.
- ~cape-wrap-passthrough~, ~cape-capf-passthrough~: Defeat entire completion style filtering.
- ~cape-wrap-predicate~, ~cape-capf-predicate~: Add candidate predicate to a Capf.
-- ~cape-wrap-properties~, ~cape-capf-properties~: Add completion properties to a Capf.
- ~cape-wrap-prefix-length~, ~cape-capf-prefix-length~: Enforce a minimal prefix length.
+- ~cape-wrap-properties~, ~cape-capf-properties~: Add completion properties to a Capf.
+- ~cape-wrap-purify~, ~cape-capf-purify~: Purify a broken Capf and ensure that it does not modify the buffer.
+- ~cape-wrap-silent~, ~cape-capf-silent~: Wrap a chatty Capf and silence it.
- ~cape-wrap-super~, ~cape-capf-super~: Merge multiple Capfs into a Super-Capf.
-- ~cape-wrap-inside-comment~, ~cape-capf-inside-comment~: Ensure that Capf triggers only inside comment.
-- ~cape-wrap-inside-faces~, ~cape-capf-inside-faces~: Ensure that Capf triggers only inside text with certain faces.
-- ~cape-wrap-inside-string~, ~cape-capf-inside-string~: Ensure that Capf triggers only inside a string literal.
In the following we show a few example configurations, which have come up on the
[[https://github.com/minad/cape/issues][Cape]] or [[https://github.com/minad/corfu/issues][Corfu issue tracker]] or the [[https://github.com/minad/corfu/wiki][Corfu wiki.]] I use some of these tweaks in my
@@ -303,7 +303,7 @@ personal configuration.
;; Example 6: Define interactive Capf which can be bound to a key. Here we wrap
;; the `elisp-completion-at-point' such that we can complete Elisp code
;; explicitly in arbitrary buffers.
-(keymap-global-set "C-c p e" (cape-interactive-capf #'elisp-completion-at-point))
+(keymap-global-set "C-c p e" (cape-capf-interactive #'elisp-completion-at-point))
;; Example 7: Ignore :keywords in Elisp completion.
(defun ignore-elisp-keywords (sym)
diff --git a/cape.el b/cape.el
index 8de9436..a41450b 100644
--- a/cape.el
+++ b/cape.el
@@ -837,7 +837,7 @@ changed. The function `cape-company-to-capf' is experimental."
capfs ", ")))))
;;;###autoload
-(defun cape-interactive-capf (capf)
+(defun cape-capf-interactive (capf)
"Create interactive completion function from CAPF."
(lambda (&optional interactive)
(interactive (list t))
@@ -1165,6 +1165,9 @@ This function can be used as an advice around an existing Capf."
(cape--capf-wrapper silent)
;;;###autoload
+(define-obsolete-function-alias 'cape-interactive-capf #'cape-capf-interactive "0.17")
+
+;;;###autoload
(define-obsolete-function-alias 'cape-super-capf #'cape-capf-super "0.17")
;;;###autoload