procyberian/emacs
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* lisp/emacs-lisp/eldoc.el (eldoc-documentation-function): Change default.

Browse source 
(eldoc-mode, eldoc-schedule-timer): Adjust to new default.
This commit is contained in:
Stefan Monnier 2014-12-10 21:56:33 -05:00
parent 7b24460087
commit 964f16e168
2 changed files with 19 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

16
lisp/emacs-lisp/eldoc.el
View file

@ -79,8 +79,8 @@ This has two preferred values: `upcase' or `downcase'.
Actually, any name of a function which takes a string as an argument and
returns another string is acceptable.
Note that if `eldoc-documentation-function' is non-nil, this variable
has no effect, unless the function handles it explicitly."
Note that this variable has no effect, unless
`eldoc-documentation-function' handles it explicitly."
:type '(radio (function-item upcase)
(function-item downcase)
function)
@ -102,8 +102,8 @@ If value is nil, messages are always truncated to fit in a single line of
display in the echo area. Function or variable symbol name may be
truncated to make more of the arglist or documentation string visible.
Note that if `eldoc-documentation-function' is non-nil, this variable
has no effect, unless the function handles it explicitly."
Note that this variable has no effect, unless
`eldoc-documentation-function' handles it explicitly."
:type '(radio (const :tag "Always" t)
(const :tag "Never" nil)
(const :tag "Yes, but truncate symbol names if it will\
@ -186,7 +186,7 @@ expression point is on."
:group 'eldoc :lighter eldoc-minor-mode-string
(setq eldoc-last-message nil)
(cond
((not eldoc-documentation-function)
((memq eldoc-documentation-function '(nil ignore))
(message "There is no ElDoc support in this buffer")
(setq eldoc-mode nil))
(eldoc-mode
@ -225,7 +225,9 @@ expression point is on."
eldoc-idle-delay t
(lambda ()
(when (or eldoc-mode
(and global-eldoc-mode eldoc-documentation-function))
(and global-eldoc-mode
(not (memq eldoc-documentation-function
'(nil ignore)))))
(eldoc-print-current-symbol-info))))))
;; If user has changed the idle delay, update the timer.
@ -321,7 +323,7 @@ Otherwise work like `message'."
;;;###autoload
(defvar eldoc-documentation-function nil
(defvar eldoc-documentation-function #'ignore
"Function to call to return doc string.
The function of no args should return a one-line string for displaying
doc about a function etc. appropriate to the context around point.