branch: elpa/eldoc-mouse
commit 50d316e0db619a8cb1c5c6885cb8b5813d64116b
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Update usage instructions in eldoc-mouse.el
Clarify usage instructions for eldoc-mouse integration.
---
eldoc-mouse.el | 8 ++++++--
1 file changed, 6 insertions(+), 2 deletions(-)
diff --git a/eldoc-mouse.el b/eldoc-mouse.el
index 970511a4777..6cc3db974a0 100644
--- a/eldoc-mouse.el
+++ b/eldoc-mouse.el
@@ -32,8 +32,12 @@
;; documentation. Enable it in buffers that you want to show documentation
using
;; eldoc for the symbol under the mouse cursor.
-;; To use, ensure posframe is installed, then add:
-;; (require 'eldoc-mouse)
+;; To use, ensure posframe is installed, then add the following:
+
+;; The following two lines are both optional, but you would like to add at
least one of them to your Emacs configuration.
+;; (use-package eldoc-mouse :hook (eglot-managed-mode emacs-lisp-mode)) ;;
enable mouse hover for eglot managed buffers, and emacs lisp buffers.
+;; (global-set-key (kbd "<f1> <f1>") 'eldoc-mouse-pop-doc-at-cursor) ;;
replace <f1> <f1> to a key you like. Displaying document on a popup when you
press a key.
+
;; to your Emacs configuration.
;;; Code:
