branch: elpa/inf-clojure
commit 727b6be5da56c2203baf2e445656bae48e73e38f
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix stale completion-related references in docs and docstrings
The per-REPL-type defcustoms (inf-clojure-completion-form,
inf-clojure-completion-form-planck, etc.) were removed in 3.0.0
when everything moved to inf-clojure-repl-features. Also fix the
function name inf-clojure-update-repl-feature -> inf-clojure-update-feature.
---
README.md | 17 +++++------------
inf-clojure.el | 4 ++--
2 files changed, 7 insertions(+), 14 deletions(-)
diff --git a/README.md b/README.md
index 95b8d878fc..efb462d24e 100644
--- a/README.md
+++ b/README.md
@@ -227,7 +227,7 @@ The `inf-clojure-repl-features` data structure is just an
alist of alists, so you can manipulate it in numerous ways.
If you want to update a specific form there is a function
-`inf-clojure-update-repl-feature` which can be used like so:
+`inf-clojure-update-feature` which can be used like so:
```emacs-lisp
(inf-clojure-update-feature 'clojure 'completion "(incomplete.core/completions
\"%s\")")
@@ -439,20 +439,13 @@ Use the startup command: `clojure -A:compliment`. Then
require the ns
once so that the completion machinery will work: `(require
'compliment.core)`. Now tab completion should work.
-For more advanced customization, code completion is particularly open
-to customization. Not only you can `setq` the customary
-`inf-clojure-completion-form`,
-`inf-clojure-completion-form-planck` and
-`inf-clojure-completion-form-joker` - the form to send to the REPL -
-but you can also use `inf-clojure-completions-fn` for specifying a
-function that given the REPL response should return Elisp data
-compatible with
+You can also customize `inf-clojure-completions-fn` to specify a
+function that parses the REPL's completion response and returns Elisp
+data compatible with
[`completion-at-point-functions`](https://www.gnu.org/software/emacs/manual/html_node/elisp/Completion-in-Buffers.html).
For more info run `M-x describe-variable RET
-inf-clojure-completions-fn`. Another option is to have a look at [how
-CIDER does
-it](https://github.com/clojure-emacs/cider/blob/3e9ed12e8cfbad04d7618e649322765dc9bff5d6/cider-interaction.el#L595).
+inf-clojure-completions-fn`.
## Troubleshooting
diff --git a/inf-clojure.el b/inf-clojure.el
index 3b0e8b9773..a0923c22b7 100644
--- a/inf-clojure.el
+++ b/inf-clojure.el
@@ -1396,7 +1396,7 @@ every other EXPR will be discarded and nil will be
returned."
"The function that parses completion results.
It is a single-arity function that will receive the REPL
-evaluation result of \\[inf-clojure-completion-form] as string and
+evaluation result of the completion feature form as string and
should return elisp data compatible with your completion mode.
The easiest possible data passed in input is a list of
@@ -1421,7 +1421,7 @@ you might want to use in your customization."
Under the hood it calls the function
\\[inf-clojure-completions-fn] passing in the result of
-evaluating \\[inf-clojure-completion-form] at the REPL."
+evaluating the completion feature form at the REPL."
(let* ((proc (inf-clojure-proc 'no-error))
(completion-form (inf-clojure-get-feature proc 'completion t)))
(when (and proc completion-form (not (string-blank-p expr)))
