all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Deniz Dogan <deniz@dogan.se>
To: 3135@debbugs.gnu.org
Subject: bug#3135: 23.0.92; doc of custom-variable-documentation
Date: Mon, 11 Jul 2011 19:30:51 +0200	[thread overview]
Message-ID: <4E1B334B.4070305@dogan.se> (raw)
In-Reply-To: <FBB25944C0AE4937AFA206624127734C@us.oracle.com>

On 2011-07-11 18:24, Drew Adams wrote:
>>>> In my opinion, it's clear enough as it is.
>>>
>>> What makes it clear that VARIABLE is not necessarily a user variable
>>> (`user-variable-p')?
>>
>> It says nothing about VARIABLE being a special kind of variable, so it
>> seems pretty obvious to me that it's talking about all kinds of
>> variables.
>
> It might be clear to you, but not to users.  Customize is all about user
> variables (options).  We should be very clear whenever we mean a variable that
> is not necessarily a user variable.
>

For what it's worth, I'm with Lars on this one.  We shouldn't have to 
clarify what things are *not*, only what they are, concisely.  Both 
defvars and defcustoms can have docstrings and I don't think anyone is 
confused by it.

> What does this added clarity cost?  It's about _users_; it's not about Emacs
> Dev's ease in dispatching bugs summarily.
>

It doesn't cost many bytes, but unnecessary "clarity" is...unnecessary. 
  I don't see why any user would be confused by this.

Deniz





  reply	other threads:[~2011-07-11 17:30 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-04-27 21:16 bug#3135: 23.0.92; doc of custom-variable-documentation Drew Adams
2011-07-11 14:59 ` Lars Magne Ingebrigtsen
2011-07-11 15:51   ` Drew Adams
2011-07-11 15:56     ` Lars Magne Ingebrigtsen
2011-07-11 16:24       ` Drew Adams
2011-07-11 17:30         ` Deniz Dogan [this message]
2011-07-12  2:57           ` Chong Yidong
2011-07-12 19:06           ` 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

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

  git send-email \
    --in-reply-to=4E1B334B.4070305@dogan.se \
    --to=deniz@dogan.se \
    --cc=3135@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 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.