diff options
author | Lars Ingebrigtsen <larsi@gnus.org> | 2016-05-01 01:08:23 +0200 |
---|---|---|
committer | Lars Ingebrigtsen <larsi@gnus.org> | 2016-05-01 19:27:17 +0200 |
commit | 350792e356c23cb1a1dfbbd8e8e342e26830c185 (patch) | |
tree | 124407ada2f6667f2bf6d0fd60c28586a5e63a29 | |
parent | c3b3b90ac08c3d20adcbe7577622e97a9797114c (diff) | |
download | emacs-350792e356c23cb1a1dfbbd8e8e342e26830c185.tar.gz |
global-eldoc-mode doc fix
* lisp/emacs-lisp/eldoc.el (global-eldoc-mode): Be more
specific about what "applicable" means (bug#23071).
(cherry picked from commit 25e95b5dd8cd92e03788e589bf99a4b399f03114)
-rw-r--r-- | lisp/emacs-lisp/eldoc.el | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index d5e7178b226..096102ae7e1 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -201,8 +201,16 @@ expression point is on." ;;;###autoload (define-minor-mode global-eldoc-mode - "Enable `eldoc-mode' in all buffers where it's applicable." - :group 'eldoc :global t + "Toggle Global Eldoc mode on or off. +With a prefix argument ARG, enable Global Eldoc mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil, and toggle it if ARG is ‘toggle’. + +If Global Eldoc mode is on, `eldoc-mode' will be enabled in all +buffers where it's applicable. These are buffers that have modes +that have enabled eldoc support. See `eldoc-documentation-function'." + :group 'eldoc + :global t :initialize 'custom-initialize-delay :init-value t (setq eldoc-last-message nil) |