docs(clojure): clarify optional deps & add enrich-classpath note
This commit is contained in:
parent
45f86d9459
commit
fbf7e86b8e
1 changed files with 13 additions and 4 deletions
|
@ -43,6 +43,8 @@ This module adds support for the Clojure(Script) language.
|
||||||
|
|
||||||
This module requires:
|
This module requires:
|
||||||
- [[https://clojure.org/][clojure]]
|
- [[https://clojure.org/][clojure]]
|
||||||
|
|
||||||
|
This module optionally requires:
|
||||||
- [[https://github.com/borkdude/clj-kondo][clj-kondo]], for linting code (if [[doom-module::checkers syntax]])
|
- [[https://github.com/borkdude/clj-kondo][clj-kondo]], for linting code (if [[doom-module::checkers syntax]])
|
||||||
- [[https://clojure-lsp.github.io/clojure-lsp/][clojure-lsp]], for LSP support (if [[doom-module:+lsp]])
|
- [[https://clojure-lsp.github.io/clojure-lsp/][clojure-lsp]], for LSP support (if [[doom-module:+lsp]])
|
||||||
- [[https://github.com/babashka/neil][neil]] for the ability to add packages to your Clojure project from Emacs
|
- [[https://github.com/babashka/neil][neil]] for the ability to add packages to your Clojure project from Emacs
|
||||||
|
@ -147,10 +149,17 @@ Several bindings used for viewing documentation for various functions, both insi
|
||||||
| [[kbd:][K]] | ~+lookup/documentation~ |
|
| [[kbd:][K]] | ~+lookup/documentation~ |
|
||||||
|
|
||||||
|
|
||||||
* TODO Configuration
|
* Configuration
|
||||||
#+begin_quote
|
** =enrich-classpath=
|
||||||
This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
|
In recent versions, an option has been introduced that attempts to improve the experience of CIDER by accessing java source & javadocs, though this option is still currently considered beta.
|
||||||
#+end_quote
|
|
||||||
|
In order to opt into this, add the following to your =config.el=
|
||||||
|
|
||||||
|
#+begin_src emacs-lisp
|
||||||
|
(setq cider-enrich-classpath t)
|
||||||
|
#+end_src
|
||||||
|
|
||||||
|
See [[https://docs.cider.mx/cider/config/basic_config.html#use-enrich-classpath][the docs]] for more
|
||||||
|
|
||||||
* Troubleshooting
|
* Troubleshooting
|
||||||
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
/There are no known problems with this module./ [[doom-report:][Report one?]]
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue