diff options
| author | Lars Ingebrigtsen <larsi@gnus.org> | 2016-05-01 01:08:23 +0200 |
|---|---|---|
| committer | Lars Ingebrigtsen <larsi@gnus.org> | 2016-05-01 01:08:23 +0200 |
| commit | 25e95b5dd8cd92e03788e589bf99a4b399f03114 (patch) | |
| tree | 952065e0e3deb8c4f81cccef7209390e7a3e483a /lisp/emacs-lisp/eldoc.el | |
| parent | d0b0cd667129c3ea8ea834f1a28a994453144cb2 (diff) | |
| download | emacs-25e95b5dd8cd92e03788e589bf99a4b399f03114.tar.gz | |
global-eldoc-mode doc fix
* lisp/emacs-lisp/eldoc.el (global-eldoc-mode): Be more
specific about what "applicable" means (bug#23071).
Diffstat (limited to 'lisp/emacs-lisp/eldoc.el')
| -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 bc5a78bd086..6c2f869f260 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -204,8 +204,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) |