[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/inf-clojure 8247c43 067/313: Add ElDoc info to README
From: |
ELPA Syncer |
Subject: |
[nongnu] elpa/inf-clojure 8247c43 067/313: Add ElDoc info to README |
Date: |
Wed, 11 Aug 2021 09:59:48 -0400 (EDT) |
branch: elpa/inf-clojure
commit 8247c430b85e2c478cc6f8e8d57e4c58f8a109c2
Author: Okke Tijhuis <o.tijhuis@gmail.com>
Commit: Okke Tijhuis <o.tijhuis@gmail.com>
Add ElDoc info to README
---
README.md | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/README.md b/README.md
index 159f7c1..85ee9c7 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,26 @@ result will be nothing short of havoc.**
`M-x inf-clojure` or `C-c C-z` within a Clojure source file.
+## ElDoc
+
+`eldoc-mode` is supported in Clojure source buffers and `*inferior-clojure*`
+buffers which are running a Clojure REPL.
+
+When ElDoc is enabled and there is an active REPL, it will show the
+argument list of the function call you are currently editing in the
+echo area.
+
+You can activate ElDoc with `M-x eldoc-mode` or by adding the
+following to you Emacs config:
+
+```el
+(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.
+
## Troubleshooting
### REPL not responsive in Windows OS
- [nongnu] elpa/inf-clojure 582601e 134/313: Fix missing inf-clojure-set-ns-form-lumo, (continued)
- [nongnu] elpa/inf-clojure 582601e 134/313: Fix missing inf-clojure-set-ns-form-lumo, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 6bd986d 146/313: Fix typo in docstring, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 339093c 056/313: Replace multiple newlines by single one or add one, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 78d2ab2 034/313: Add a command for clearing the REPL buffer, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure c9f2f63 036/313: Fix eval defun keybinding, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 75f6fab 039/313: Update copyright years, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 8594a58 042/313: Add new-line mark after inf-clojure-arglist-command, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure d2bedf9 048/313: Fix the installation instructions in the Elisp snippet, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 7aa0299 062/313: Refactoring, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 64263f7 045/313: Fix a typo, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 8247c43 067/313: Add ElDoc info to README,
ELPA Syncer <=
- [nongnu] elpa/inf-clojure 6758a31 069/313: Fix for older Emacs, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 0a7c61b 079/313: Fix a docstring, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 0259801 080/313: Kill a trailing space, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 63c2f9e 082/313: Add possibility to customize more vars, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure d9e4400 087/313: Tweak the README a bit, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 117d8cb 090/313: Bump the clojure-mode and Emacs deps, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure e12db12 091/313: Fix prompt being included in input history, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure e6a4ef3 093/313: Add some handy GitHub templates to improve the contribution process, ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 6a354dc 097/313: Add defcustom `inf-clojure-prompt-on-set-ns` (#46), ELPA Syncer, 2021/08/11
- [nongnu] elpa/inf-clojure 6e55048 099/313: [Fix #42] Add a defcustom controlling the window in which the REPL buffer is displayed, ELPA Syncer, 2021/08/11