From c7fea8278e2c0ab27412dbe22a63502c01ac3759 Mon Sep 17 00:00:00 2001 From: Yuan Fu Date: Thu, 20 Dec 2018 22:19:58 -0500 Subject: [PATCH] Update README --- README.org | 2 +- eldoc-box.el | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.org b/README.org index 8b76fda..41248d0 100644 --- a/README.org +++ b/README.org @@ -19,7 +19,7 @@ Get the file, add to load path, and ** Variable - =eldoc-box-max-pixel-width= & =eldoc-box-max-pixel-height= :: Set them according to the screen resolution of your machine. - =eldoc-box-only-multi-line= :: Set this to non-nil and eldoc-box only display multi-line message in childframe. One line messages are left in minibuffer. -- =eldoc-box-cleanup-interval= :: After this amount of seconds will eldoc-box attempt to cleanup the childframe. E.g. if it is set to 1, the childframe is cleared 1 second after you moved the point to somewhere else (that doesn't have a doc to show). +- =eldoc-box-cleanup-interval= :: After this amount of seconds will eldoc-box attempt to cleanup the childframe. E.g. if it is set to 1, the childframe is cleared 1 second after you moved the point to somewhere else (that doesn't have a doc to show). This doesn't apply to =eldoc-box-hover-at-point-mode=, in that mode the childframe is cleared as soon as point moves. ** Use with eglot As of writing this README, eglot doesn't have a public mode hook, use this hook: diff --git a/eldoc-box.el b/eldoc-box.el index ab7135f..d66a61a 100644 --- a/eldoc-box.el +++ b/eldoc-box.el @@ -57,7 +57,9 @@ (defvar eldoc-box-cleanup-interval 1 "After this amount of seconds will eldoc-box attempt to cleanup the childframe. E.g. if it is set to 1, the childframe is cleared 1 second after -you moved the point to somewhere else (that doesn't have a doc to show)") +you moved the point to somewhere else (that doesn't have a doc to show). +This doesn't apply to =eldoc-box-hover-at-point-mode=, +in that mode the childframe is cleared as soon as point moves.") (defvar eldoc-box-clear-with-C-g nil "If set to non-nil, eldoc-box clears cildframe when you hit \C-g.")