Update README

This commit is contained in:
Yuan Fu 2020-04-06 14:44:01 -04:00
parent 7fa3b78d07
commit c1a1b77ec0
No known key found for this signature in database
GPG Key ID: 56E19BC57664A442

View File

@ -13,9 +13,11 @@ Get the file, add to load path, and
(require 'eldoc-box) (require 'eldoc-box)
#+END_SRC #+END_SRC
It is also available on [[https://melpa.org/#/eldoc-box][MELPA]] It is also available on [[https://melpa.org/#/eldoc-box][MELPA]].
* Usage * Usage
*Note:* If you use Gnome and Emacs 27, set ~x-gtk-resize-child-frames~ to ~resize-mode~ to avoid breakage of childframe.
** Function ** Function
- =eldoc-box-hover-mode= :: Display documentation of the symbol at point in a childframe on upper corner. - =eldoc-box-hover-mode= :: Display documentation of the symbol at point in a childframe on upper corner.
- =eldoc-box-hover-at-point-mode= :: Same as =eldoc-box-hover-mode= except the childframe is displayed at point, instead of on the upper corner. - =eldoc-box-hover-at-point-mode= :: Same as =eldoc-box-hover-mode= except the childframe is displayed at point, instead of on the upper corner.