unofficial mirror of emacs-devel@gnu.org 
 help / color / mirror / code / Atom feed
From: Dan Nicolaescu <dann@ics.uci.edu>
To: "Drew Adams" <drew.adams@oracle.com>
Cc: rms@gnu.org, emacs-devel@gnu.org
Subject: Re: tooltips for minor modes
Date: Thu, 21 Feb 2008 01:19:01 -0800	[thread overview]
Message-ID: <200802210919.m1L9J1gi006108@sallyv1.ics.uci.edu> (raw)
In-Reply-To: <008401c87375$351efbd0$0600a8c0@us.oracle.com> (Drew Adams's message of "Tue, 19 Feb 2008 20:01:01 -0800")

"Drew Adams" <drew.adams@oracle.com> 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 ?




  reply	other threads:[~2008-02-21  9:19 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-02-19  8:20 tooltips for minor modes Dan Nicolaescu
2008-02-19  9:38 ` David Kastrup
2008-02-19  9:47   ` Dan Nicolaescu
2008-02-19 23:10 ` Richard Stallman
2008-02-20  4:01   ` Drew Adams
2008-02-21  9:19     ` Dan Nicolaescu [this message]
2008-02-21  9:37       ` Drew Adams
2008-02-21 22:29       ` Richard Stallman
2008-02-21 23:10         ` Drew Adams
2008-02-22  2:01           ` Stefan Monnier
2008-02-22 19:19             ` Dan Nicolaescu
2008-02-22 22:56           ` Richard Stallman

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=200802210919.m1L9J1gi006108@sallyv1.ics.uci.edu \
    --to=dann@ics.uci.edu \
    --cc=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=rms@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).