branch: elpa/eldoc-mouse
commit 1e9a0326833696a8cbe9afc6c19b34748b6f07ab
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Revise eldoc-mouse usage instructions
Updated comments and usage instructions for eldoc-mouse.
---
eldoc-mouse.el | 16 ++++++++++++----
1 file changed, 12 insertions(+), 4 deletions(-)
diff --git a/eldoc-mouse.el b/eldoc-mouse.el
index b56ab3980a6..a4ccd2492cf 100644
--- a/eldoc-mouse.el
+++ b/eldoc-mouse.el
@@ -33,10 +33,18 @@
;; eldoc for the symbol under the mouse cursor.
;; 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.
+;; (use-package eldoc-mouse
+;; ;; replace <f1> <f1> to a key you like, "C-h ." maybe. Displaying
document on a popup when you press a key.
+;; :bind (:map eldoc-mouse-mode-map
+;; ("<f1> <f1>" . eldoc-mouse-pop-doc-at-cursor)) ;; optional
+;; ;; enable mouse hover for eglot managed buffers, and emacs lisp buffers.
;; optional
+;; :hook (eglot-managed-mode emacs-lisp-mode))
+
+;; Or if you want to show document only when you press a key, and don't want
to enable mouse hover, then:
+
+;; (use-package eldoc-mouse)
+;; ;; replace <f1> <f1> to a key you like. Displaying document on a popup
when you press a key.
+;; (global-set-key (kbd "<f1> <f1>") 'eldoc-mouse-pop-doc-at-cursor)
;; to your Emacs configuration.
