branch: elpa/eldoc-mouse
commit 20d3d880f681fdc5402ca393fe9046e1d8fa25de
Author: huangfeiyu <[email protected]>
Commit: GitHub <[email protected]>
Fix eldoc-mouse variable name and update instructions
Corrected variable name in eldoc-mouse documentation and added instructions
for non-Emacs modes.
---
README.md | 6 +++++-
1 file changed, 5 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index ab40c8308ec..6ed4921c035 100644
--- a/README.md
+++ b/README.md
@@ -90,11 +90,15 @@ You can customize the behavior of eldoc-mouse by adjusting
the variables. For in
```
2. add the function name to the `eldoc-mouse` variable
`eldoc-mouse--eldoc-documentation-functions`. for example:
```elisp
- (defvar-local eldoc-mouse--eldoc-documentation-functions
+ (defvar-local eldoc-mouse-eldoc-documentation-functions
(list #'eldoc-mouse--eglot-eldoc-documentation-function
#'eldoc-mouse--elisp-eldoc-documentation-function)
"The `eldoc-documentation-functions' for `eldoc-mouse-mode'.")
```
3. submit a pull request. I'd love to merge it.
+4. For modes that is not part of Emacs, pull request is not a choice, instead,
you can add your customized function as hook by the following:
+ ```elisp
+ (add-hook 'eldoc-mouse-eldoc-documentation-functions
#'your-customized-eldoc-documentation-function nil t)
+ ```
## Requirements
