Re: Leading * in docstrings of defcustoms.

[Chong Yidong]

"Drew Adams" <address@hidden> writes:

> Elisp manual nodes:
>
> * Defining Variables
>
>   If the variable is a user option that users would want to set
>   interactively, you should use `*' as the first character of
>                  ^^^^^^^^^^^^^^^^^^
>
> While this "if" is true, and nothing here claims the "only if" case,
> it's easy to misread that text

Agreed.  I reworded this paragraph to make it clearer.

> * Accessing Documentation
>
>   goal-column     Option
>   *Semipermanent goal column for vertical motion, as set by ...
>
>   The asterisk `*' as the first character of a variable's doc string,
>   as shown above for the `goal-column' variable, means that it is a
>   user option; see the description of `defvar' in *Note Defining
>   Variables::.
>
> Again, depending on what is understood by "means", one can read this
> as saying that `*' is necessary if you want the variable to be a user
> option.

The goal-column docstring doesn't have the asterisk anymore, anyway.
I've updated the text accordingly.

Thanks for the catch(es).