branch: elpa/eldoc-mouse
commit 6dac97be33a5e99d08c51894d9fb24d1e1462f28
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Update README.md
---
README.md | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 133949c14dd..7af30356c0c 100644
--- a/README.md
+++ b/README.md
@@ -1,11 +1,11 @@
# eldoc-mouse
-`eldoc-mouse` is an Emacs package that enhances the `eldoc` functionality by
displaying documentation in a child frame at the mouse point using
[posframe](https://github.com/tumashu/posframe) when the mouse hovers over a
symbol in an `eglot` managed buffer. It integrates with `posframe` to provide
popup documentation and features a debounced hover mechanism to prevent
excessive requests to the LSP server.
+`eldoc-mouse` is an Emacs package that enhances the `eldoc` functionality by
displaying documentation in a popup at the mouse point using
[posframe](https://github.com/tumashu/posframe) when the mouse hovers over a
symbol in an `eglot` managed buffer. It integrates with `posframe` to provide
popping up documentation and features a debounced hover mechanism to prevent
excessive requests to the LSP server.
[Eldoc-mouse Demo at Youtube](https://youtu.be/XFAc4WyiJjI)
<video
src="https://github.com/user-attachments/assets/5622cfd2-de0c-46e8-9276-d67615671932";
controls></video>
## Features
-- Displays documentation in a child frame when hovering over symbols in
`eglot` managed buffers.
+- Displays documentation in a popup when hovering over symbols in `eglot`
managed buffers.
- Integrates with `posframe` for popup documentation.
- Support moving mouse to the popup by move mouse on it and click.
- Automatically hide the popup when mouse moved away from the symbol, also
supoort pressing `C-g` to hide the popup.
