doomemacs/modules/lang/emacs-lisp/README.org

#+title:    :lang emacs-lisp
#+subtitle: A parsel-tongue for the oldest serpent
#+created:  January 16, 2017
#+since:    1.3

* Description :unfold:
This module extends support for Emacs Lisp in Doom Emacs.

- Macro expansion
- Go-to-definitions or references functionality
- Syntax highlighting for defined and quoted symbols
- Replaces the built-in help with the more powerful [[doom-package:helpful]]
- Adds function example uses to documentation

** Maintainers
- [[doom-user:][@hlissner]]

[[doom-contrib-maintainer:][Become a maintainer?]]

** Module flags
/This module has no flags./

** Packages
- [[doom-package:buttercup]]
- [[doom-package:elisp-def]]
- [[doom-package:elisp-demos]]
- [[doom-package:flycheck-cask]] if [[doom-module::checkers syntax]]
- [[doom-package:flycheck-package]] if [[doom-module::checkers syntax]]
- [[doom-package:highlight-quoted]]
- [[doom-package:macrostep]]
- [[doom-package:overseer]]

** Hacks
- Symbols that are defined in the current session are highlighted with
  ~font-lock-variable-face~.
- Eldoc will display the values of variables next to its documentation.
- ~elisp-demos~ was modified to display API demos for Doom's standard library
  (in [[file:../../../docs/api.org][docs/api.org]]).
- This module extends imenu support for Doom's API (e.g. ~package!~,
  ~use-package~, ~after!~)
- Flycheck has been configured to tone down the false positives when you are
  editing your Emacs or Doom config.

** TODO Changelog
# This section will be machine generated. Don't edit it by hand.
/This module does not have a changelog yet./

* Installation
[[id:01cffea4-3329-45e2-a892-95a384ab2338][Enable this module in your ~doom!~ block.]]

This module's sole dependency is Emacs. It's very obscure, you wouldn't know
about it.

* TODO Usage
#+begin_quote
 󱌣 This module has no usage documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

** formatter
By enabling [[doom-module::editor format]], [[doom-package:apheleia]] will be
used to format the current buffer.

Enable [[doom-module::editor format +onsave]] to format the buffer on save.

* TODO Configuration
#+begin_quote
 󱌣 This module has no configuration documentation yet. [[doom-contrib-module:][Write some?]]
#+end_quote

* Troubleshooting
/There are no known problems with this module./ [[doom-report:][Report one?]]

* Frequently asked questions
/This module has no FAQs yet./ [[doom-suggest-faq:][Ask one?]]

* TODO Appendix
#+begin_quote
 󱌣 This module has no appendix yet. [[doom-contrib-module:][Write one?]]
#+end_quote