Simple ElDoc frontend that displays documentation in a floating child frame
Go to file
2018-12-16 22:40:26 -05:00
eldoc-box.el Fix #4: CPU 100% 2018-12-16 15:47:49 -05:00
README.org Add screenshot for melpa 2018-12-16 22:40:26 -05:00
screenshot.png Add screenshot for melpa 2018-12-16 22:40:26 -05:00

ElDoc box

This package displays ElDoc documentations in a childframe.

/jessieh/eldoc-frame/media/commit/55bba3ed91072759c1309637b3f487d7b287e4a8/screenshot.png
Using with eglot in python-mode

Install

Get the file, add to load path, and

(require 'eldoc-box)

Usage

Function

eldoc-box-hover-mode
Show documentation upon hover. Note that you need to enable ElDoc mode for this to work.

Face

eldoc-box-border
Adjust :background of this face for border color.
eldoc-box-body
Adjust :background of this face for background color of childframe.

Variable

eldoc-box-max-pixel-width & eldoc-box-max-pixel-height
Set them according to the screen resolution of your machine.
eldoc-box-only-multi-line
Set this to non-nil and eldoc-box only display multi-line message in childframe. One line messages are left in minibuffer.

Use with eglot

As of writing this README, eglot doesn't have a public mode hook, use this hook:

(add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t)