branch: elpa/inf-clojure
commit 44d8896d46269fa795da48ea7b48d552941dd5b1
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Fix ElDoc section: wrong buffer name and stale Emacs version reference
The buffer is *inf-clojure*, not *inferior-clojure*. The Emacs 26.1+
note and manual eldoc-mode activation instructions are unnecessary
since the package requires Emacs 28+ where ElDoc is always enabled.
---
README.md | 11 +----------
1 file changed, 1 insertion(+), 10 deletions(-)
diff --git a/README.md b/README.md
index 60fc581155..5cbe792a0c 100644
--- a/README.md
+++ b/README.md
@@ -458,7 +458,7 @@ startup when using the `inf-clojure` command or is
specified manually when using
#### ElDoc
-`eldoc-mode` is supported in Clojure source buffers and `*inferior-clojure*`
+`eldoc-mode` is supported in Clojure source buffers and `*inf-clojure*`
buffers which are running a Clojure REPL.
When ElDoc is enabled and there is an active REPL, it will show the argument
@@ -468,15 +468,6 @@ your cursor. One side effect of this is that it can mess
with repl vars like
`*1` and `*2`. You can disable inf-clojure's Eldoc functionality with `(setq
inf-clojure-enable-eldoc nil)`.
-ElDoc should be enabled by default in Emacs 26.1+. If it is not active by
-default, you can activate ElDoc with `M-x eldoc-mode` or by adding the
following
-to you Emacs config:
-
-```emacs-lisp
-(add-hook 'clojure-mode-hook #'eldoc-mode)
-(add-hook 'inf-clojure-mode-hook #'eldoc-mode)
-```
-
ElDoc currently doesn't work with ClojureScript buffers and REPL's.
You can leave it enabled, it just won't show anything in the echo area.
