This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/layers/+emacs/helpful
Maximilian Wolff d2f6d08247
Make helpful layer replace existing emacs help functions
The helpful layer delivers more sophisticated help buffers,
at least for elisp and emacs specific objects. Therefore
it makes sense to replace the existing help functions for
these bindings silently if this layer is loaded.
2019-12-08 10:29:46 +01:00
..
config.el Make helpful layer replace existing emacs help functions 2019-12-08 10:29:46 +01:00
packages.el Make helpful layer replace existing emacs help functions 2019-12-08 10:29:46 +01:00
README.org Make helpful layer replace existing emacs help functions 2019-12-08 10:29:46 +01:00

helpful layer

Description

This layer replaces the existing emacs related help buffers with more detailed ones.

Features:

  • Better help buffers with helpful for emacs related buffers
  • Source code shown implicitly in help buffer for all lisp objects
  • More detailed descriptions in the emacs specific function, variable and key help buffers
  • Better formatted elisp docstrings

Install

To use this configuration layer, add it to your ~/.spacemacs. You will need to add helpful to the existing dotspacemacs-configuration-layers list in this file.

Key bindings

This layer aims to silently replace the standard emacs help key bindings with improved versions. So it does not introduce new bindings. For the sake of completion you can find below all keys which are replaced by this layer.

Key Binding Description
SPC m h h Open helpful buffer for item under point in elisp mode
SPC h d k Open helpful buffer for key binding
SPC h d f Open helpful buffer for any callable object
SPC h h v Open helpful buffer for variable