bug#3135: 23.0.92; doc of custom-variable-documentation

[Deniz Dogan]

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