spacemacs/layers/+emacs/helpful
Maximilian Wolff b82bc40b3c
Fix ignored popwin declarations
Popwin automatically configures pupo purposes
if properly configured. While I was checking
the existing configs I have found that the
settings will be ignored if the config is not
done via a post-config hook.

A quick search revealed a lot of popwin configs
which never had any effect.

This commit fixes these and with this also
restores the missing pupo configs.
2020-07-03 21:51:33 +02:00
..
README.org documentation formatting: Tue Mar 24 20:40:51 UTC 2020 2020-03-24 21:45:10 +01:00
config.el Fix ignored popwin declarations 2020-07-03 21:51:33 +02:00
packages.el Fix ignored popwin declarations 2020-07-03 21:51:33 +02:00

README.org

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

Global 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

Helpful mode bindings

Additional key bindings available in the helpful-mode buffers.

Key binding Description
SPC m q Close all helpful-mode buffers
gr Reload the buffer (e.g. to see new variable value)
o Open link with Avy
q Close window (buffer is kept in background)