jessieh/eldoc-frame
jessieh/eldoc-frame
1
Fork 0
Code Issues Pull Requests Releases Activity

Reformat README

Browse Source
This commit is contained in:
Yuan Fu 2018-12-14 18:05:54 -05:00
parent aec39b6bd4
commit f0fb85b16e
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901
1 changed files with 1 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
README.org
View File

@ -1,11 +1,10 @@
#+TITLE: ElDoc box
This package displays ElDoc documentations in a childframe. This package displays ElDoc documentations in a childframe.
* Install * Install
Get the file, add to load path, and Get the file, add to load path, and
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(require 'eldoc-box) (require 'eldoc-box)
#+END_SRC #+END_SRC
* Usage * Usage
** Function ** Function
- =eldoc-box-hover-mode= :: Show documentation upon hover. Note that you need to enable ElDoc mode for this to work. - =eldoc-box-hover-mode= :: Show documentation upon hover. Note that you need to enable ElDoc mode for this to work.
@ -15,10 +14,8 @@ Get the file, add to load path, and
** Variable ** Variable
- =eldoc-box-max-pixel-width= & =eldoc-box-max-pixel-height= :: Set them according to the screen resolution of your machine. - =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-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 ** Use with eglot
As of writing this README, eglot doesn't have a public mode hook, use this hook: As of writing this README, eglot doesn't have a public mode hook, use this hook:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t) (add-hook 'eglot--managed-mode-hook #'eldoc-box-hover-mode t)
#+END_SRC #+END_SRC