Skip to content

Commit 8247c43

Browse files
committed
Add ElDoc info to README
1 parent 8760e41 commit 8247c43

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,26 @@ result will be nothing short of havoc.**
5454

5555
`M-x inf-clojure` or `C-c C-z` within a Clojure source file.
5656

57+
## ElDoc
58+
59+
`eldoc-mode` is supported in Clojure source buffers and `*inferior-clojure*`
60+
buffers which are running a Clojure REPL.
61+
62+
When ElDoc is enabled and there is an active REPL, it will show the
63+
argument list of the function call you are currently editing in the
64+
echo area.
65+
66+
You can activate ElDoc with `M-x eldoc-mode` or by adding the
67+
following to you Emacs config:
68+
69+
```el
70+
(add-hook 'clojure-mode-hook #'eldoc-mode)
71+
(add-hook 'inf-clojure-mode-hook #'eldoc-mode)
72+
```
73+
74+
ElDoc currently doesn't work with ClojureScript buffers and REPL's.
75+
You can leave it enabled, it just won't show anything in the echo area.
76+
5777
## Troubleshooting
5878

5979
### REPL not responsive in Windows OS

0 commit comments

Comments
 (0)