From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Dan Nicolaescu Newsgroups: gmane.emacs.devel Subject: Re: tooltips for minor modes Date: Thu, 21 Feb 2008 01:19:01 -0800 Message-ID: <200802210919.m1L9J1gi006108@sallyv1.ics.uci.edu> References: <200802190820.m1J8Knbo007894@sallyv1.ics.uci.edu> <008401c87375$351efbd0$0600a8c0@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1203585680 6296 80.91.229.12 (21 Feb 2008 09:21:20 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 21 Feb 2008 09:21:20 +0000 (UTC) Cc: rms@gnu.org, emacs-devel@gnu.org To: "Drew Adams" Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Thu Feb 21 10:21:44 2008 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1JS7cS-00017P-37 for ged-emacs-devel@m.gmane.org; Thu, 21 Feb 2008 10:21:32 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1JS7bs-0007HG-Ft for ged-emacs-devel@m.gmane.org; Thu, 21 Feb 2008 04:20:56 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1JS7bV-0006rC-2b for emacs-devel@gnu.org; Thu, 21 Feb 2008 04:20:33 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1JS7bR-0006mT-CV for emacs-devel@gnu.org; Thu, 21 Feb 2008 04:20:32 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1JS7bR-0006mE-53 for emacs-devel@gnu.org; Thu, 21 Feb 2008 04:20:29 -0500 Original-Received: from sallyv1.ics.uci.edu ([128.195.1.109]) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_3DES_EDE_CBC_SHA1:24) (Exim 4.60) (envelope-from ) id 1JS7bF-0000ws-Q6; Thu, 21 Feb 2008 04:20:20 -0500 X-ICS-MailScanner-Watermark: 1204190341.37937@jWMNQHqK0qxjWYJKd6E8iQ Original-Received: from mothra.ics.uci.edu (mothra.ics.uci.edu [128.195.6.93]) by sallyv1.ics.uci.edu (8.13.7+Sun/8.13.7) with ESMTP id m1L9J1gi006108; Thu, 21 Feb 2008 01:19:01 -0800 (PST) In-Reply-To: <008401c87375$351efbd0$0600a8c0@us.oracle.com> (Drew Adams's message of "Tue, 19 Feb 2008 20:01:01 -0800") Original-Lines: 28 X-ICS-MailScanner: Found to be clean X-ICS-MailScanner-SpamCheck: not spam, SpamAssassin (score=-1.44, required 5, autolearn=disabled, ALL_TRUSTED -1.44) X-ICS-MailScanner-From: dann@mothra.ics.uci.edu X-detected-kernel: by monty-python.gnu.org: Solaris 10 (beta) X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:89796 Archived-At: "Drew Adams" writes: > > It would be nice if the mode-line :lighter for minor > > modes would have a > > tooltip with a brief description of what the minor mode is. > > > > I think it is a good idea. We could perhaps establish a convention > > that a certain part of the doc string of the minor mode function is > > used for this. Or, if that would require changing too many doc > > strings, we could have some other way to specify the string for this. One possibility would be to use the first line of the doc-string. But a quick "grep --after=1 define-minor-mode" shows that for quite a lot of minor modes the first line of the doc-string gives not useful information: scroll-all.el:106:(define-minor-mode scroll-all-mode scroll-all.el-107- "Toggle Scroll-All minor mode. So doing either the above or the proposal below requires some editing. > Perhaps add a :help keyword to `define-minor-mode' etc.? Sounds good, and consistent with other uses for :help. Where would that :help property be stored? Drew, given that you are you touched this minor-mode stuff most recently, do you want to implement one of these ?