From: Michal Nazarewicz <mpn@google.com>
To: 19338@debbugs.gnu.org
Subject: bug#19338: [PATCH 3/3] eldoc: convert `eldoc-documentation-function' into a defcustom
Date: Wed, 10 Dec 2014 18:49:45 +0100 [thread overview]
Message-ID: <1418233785-18020-3-git-send-email-mpn@google.com> (raw)
In-Reply-To: <1418233785-18020-1-git-send-email-mpn@google.com>
From: Michal Nazarewicz <mina86@mina86.com>
* lisp/emacs-lisp/eldoc.el (eldoc-documentation-function): Change
from defvar to defcustom with `describe-char-eldoc' function
as one of the suggested values.
---
lisp/emacs-lisp/eldoc.el | 12 +++++++++---
1 file changed, 9 insertions(+), 3 deletions(-)
diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el
index 06ee164..aeddf90 100644
--- a/lisp/emacs-lisp/eldoc.el
+++ b/lisp/emacs-lisp/eldoc.el
@@ -321,8 +321,8 @@ Otherwise work like `message'."
\f
;;;###autoload
-(defvar eldoc-documentation-function nil
- "Function to call to return doc string.
+(defcustom eldoc-documentation-function nil
+ "Function to call to return doc string for ElDoc mode.
The function of no args should return a one-line string for displaying
doc about a function etc. appropriate to the context around point.
It should return nil if there's no doc appropriate for the context.
@@ -334,7 +334,13 @@ the variables `eldoc-argument-case' and `eldoc-echo-area-use-multiline-p',
and the face `eldoc-highlight-function-argument', if they are to have any
effect.
-This variable is expected to be set buffer-locally by modes that support ElDoc.")
+Major modes can set this variable buffer-locally to overwrite the global
+default, but if local documentation function returns no doc string, the global
+one will be tried as well."
+ :type '(radio (function-item describe-char-eldoc)
+ function
+ (const :tag "No documentation function" nil))
+ :group 'eldoc)
(defun eldoc-print-current-symbol-info ()
;; This is run from post-command-hook or some idle timer thing,
--
2.2.0.rc0.207.ga3a616c
next prev parent reply other threads:[~2014-12-10 17:49 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2014-12-10 17:24 bug#19338: [PATCH 0/3] Implement an ElDoc function which describes char at point Michal Nazarewicz
2014-12-10 17:49 ` bug#19338: [PATCH 1/3] eldoc: use default eldoc function if local one gives no results Michal Nazarewicz
2014-12-10 17:49 ` bug#19338: [PATCH 2/3] descr-text: add `describe-char-eldoc' describing character at point Michal Nazarewicz
2014-12-10 17:49 ` Michal Nazarewicz [this message]
2014-12-10 20:08 ` bug#19338: [PATCH 3/3] eldoc: convert `eldoc-documentation-function' into a defcustom Stefan Monnier
2014-12-10 20:05 ` bug#19338: [PATCH 1/3] eldoc: use default eldoc function if local one gives no results Stefan Monnier
2014-12-10 21:46 ` Michal Nazarewicz
2014-12-11 2:38 ` Stefan Monnier
2014-12-11 16:02 ` bug#19338: [PATCHv2 1/2] descr-text: add `describe-char-eldoc' describing character at point Michal Nazarewicz
2014-12-11 16:02 ` bug#19338: [PATCHv2 2/2] eldoc: convert `eldoc-documentation-function' into a defcustom Michal Nazarewicz
2015-01-20 14:08 ` Michal Nazarewicz
2014-12-11 16:56 ` bug#19338: [PATCHv2 1/2] descr-text: add `describe-char-eldoc' describing character at point Leo Liu
2014-12-11 17:21 ` Michal Nazarewicz
2014-12-14 19:46 ` Eli Zaretskii
2014-12-14 20:40 ` bug#19338: [PATCHv3 " Michal Nazarewicz
2014-12-11 16:59 ` bug#19338: [PATCH 1/3] eldoc: use default eldoc function if local one gives no results Stefan Monnier
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.gnu.org/software/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1418233785-18020-3-git-send-email-mpn@google.com \
--to=mpn@google.com \
--cc=19338@debbugs.gnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).