all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Drew Adams" <drew.adams@oracle.com>
To: "'Stephen J. Turnbull'" <stephen@xemacs.org>
Cc: 'martin rudalics' <rudalics@gmx.at>, emacs-devel@gnu.org
Subject: RE: option doc strings and Customize tags
Date: Tue, 28 Oct 2008 23:45:15 -0700	[thread overview]
Message-ID: <007e01c93991$e714c8f0$0200a8c0@us.oracle.com> (raw)
In-Reply-To: <87hc6wf7u2.fsf@uwakimon.sk.tsukuba.ac.jp>

> normally long values will either be indirect (eg, the value of
> variable whose name can be used instead of the value), or they will be
> compounds in which case a compound widget will be used so that the
> components can be changed.

"Normally", no. Typically, yes.

But even variable and function names can be long enough to encumber a menu item
as an annotation. And then there are long string values (regexps, fonts),
sometimes multi-line. And long sexps (e.g. lambdas). And tags themselves can be
long.

A glance at existing defcustoms in the elisp dir shows that. Most values are
short, but some are not.

Take a look at option `align-rules-list', for example. Though compound, many of
its components are very long regexps or lambdas (e.g. over 300 chars). It's not
your average defcustom, but it's by no means abnormal either.

Nevertheless, adding short values to the menu items, next to the tags, is a good
start - certainly better than offering users no correspondence at all. Practice
will then show whether it proves satisfactory.

Come to think of it, the value-vs-tag confusion is really a problem only for
symbol-valued `const' values anyway, for the most part. So adding the value
annotations only for symbol `const' values (in a `choice') would probably not be
too bad a solution. Only the occasional long symbol name plus long tag name
would be problematic.






  reply	other threads:[~2008-10-29  6:45 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2008-10-27 18:12 option doc strings and Customize tags Drew Adams
2008-10-28 19:09 ` martin rudalics
2008-10-28 19:28   ` Drew Adams
2008-10-28 19:38     ` Lennart Borgman
2008-10-28 19:49       ` Drew Adams
2008-10-28 20:03         ` Lennart Borgman
2008-10-28 20:25           ` Drew Adams
2008-10-28 20:29             ` Lennart Borgman
2008-10-30  5:01               ` Kevin Rodgers
2008-10-30  6:06                 ` Lennart Borgman
2008-10-29  2:33     ` Stephen J. Turnbull
2008-10-29  6:45       ` Drew Adams [this message]
2008-10-29 14:36         ` Stefan Monnier
2008-10-29 16:08           ` Drew Adams
2008-10-29 17:17             ` Stefan Monnier
2008-10-30  1:42             ` Stephen J. Turnbull

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

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to='007e01c93991$e714c8f0$0200a8c0@us.oracle.com' \
    --to=drew.adams@oracle.com \
    --cc=emacs-devel@gnu.org \
    --cc=rudalics@gmx.at \
    --cc=stephen@xemacs.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 external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.