jessieh/eldoc-frame
jessieh/eldoc-frame
1
Fork 0
Code Issues Pull Requests Releases Activity

Minor fixup

Browse Source 
eldoc-box--maybe-cleanup: Fix docstring typo
Add comment

eldoc-box--eldoc-message-function: Fix docstring
Add comment
minor code fix
This commit is contained in:
Yuan Fu 2018-12-12 13:28:40 -05:00
parent 27605bd370
commit 152d422aba
No known key found for this signature in database
GPG Key ID: 1CF5ECABEC37A901
1 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
eldoc-box.el
View File

@ -200,30 +200,32 @@ Checkout `lsp-ui-doc--make-frame', `lsp-ui-doc--move-frame'."
"The timer used to cleanup childframe after ElDoc.") "The timer used to cleanup childframe after ElDoc.")
(defun eldoc-box--maybe-cleanup () (defun eldoc-box--maybe-cleanup ()
"Clean up after ElDOc." "Clean up after ElDoc."
;; timer is global, so this function will be called outside ;; timer is global, so this function will be called outside
;; the buffer with `eldoc-box-hover-mode' enabled ;; the buffer with `eldoc-box-hover-mode' enabled
(if eldoc-box-hover-mode (if eldoc-box-hover-mode
;; if eldoc-last-message is nil, the childframe is cleared ;; if eldoc-last-message is nil, the childframe is cleared
(eldoc-box--eldoc-message-function eldoc-last-message) (eldoc-box--eldoc-message-function eldoc-last-message)
;; sometimes you switched buffer when childframe is on. ;; sometimes you switched buffer when childframe is on.
;; it wouldn't go away unless you goes back and let eldoc ;; it wouldn't go away unless you goes back and let eldoc shut it off.
;; shut it off. this code can save you ;; if childframe is visible and we are not in `eldoc-box-hover-mode', hide childframe
;; this is gold, right here, you know it my friend?
(when (frame-parameter eldoc-box--frame 'visibility) (when (frame-parameter eldoc-box--frame 'visibility)
(eldoc-box-quit-frame))) (eldoc-box-quit-frame)))
(setq eldoc-box--cleanup-timer nil)) (setq eldoc-box--cleanup-timer nil))
(defun eldoc-box--eldoc-message-function (str &rest args) (defun eldoc-box--eldoc-message-function (str &rest args)
"Frontend for eldoc. Display STR in childframe and ARGS works like `message'." "Front-end for eldoc. Display STR in childframe and ARGS works like `message'."
(if (stringp str) (if (stringp str)
(let ((doc (apply #'format str args))) (let ((doc (apply #'format str args)))
(unless (and eldoc-box-only-multi-line (eq (cl-count ?\n doc) 0)) (unless (and eldoc-box-only-multi-line (eq (cl-count ?\n doc) 0))
(eldoc-box--display (apply #'format str args)) (eldoc-box--display doc)
;; Why a timer? ElDoc is mainly use in minibuffer, ;; Why a timer? ElDoc is mainly use in minibuffer,
;; where the text is constantly being flushed by other commands ;; where the text is constantly being flushed by other commands
;; so ElDoc doesn't try very hard to cleanup ;; so ElDoc doesn't try very hard to cleanup
(when eldoc-box--cleanup-timer (cancel-timer eldoc-box--cleanup-timer)) (when eldoc-box--cleanup-timer (cancel-timer eldoc-box--cleanup-timer))
;; this function is also called by `eldoc-pre-command-refresh-echo-area'
;; in `pre-command-hook', which means the timer is reset before every
;; command if `eldoc-box-hover-mode' is on and `eldoc-last-message' is not nil.
(setq eldoc-box--cleanup-timer (setq eldoc-box--cleanup-timer
(run-with-timer 1 nil #'eldoc-box--maybe-cleanup)))) (run-with-timer 1 nil #'eldoc-box--maybe-cleanup))))
(eldoc-box-quit-frame) (eldoc-box-quit-frame)