eldoc-frame/README.org
Yuan Fu 112afa1137
Abstract timer interval as a variable
1 second is a bit too long, but old machines might want a longer
interval, I set it to 0.2 on my machine and CPU looks ok.
2018-12-18 12:34:48 -05:00

1.3 KiB

ElDoc box

This package displays ElDoc documentations in a childframe.

/jessieh/eldoc-frame/media/commit/c4af2c7e23587291c03e2fa54c494813429d628f/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.
eldoc-box-cleanup-interval
After this amount of seconds will eldoc-box attempt to cleanup the childframe. E.g. if it is set to 1, the childframe is cleared 1 second after you moved the point to somewhere else (that doesn't have a doc to show).

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)