[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Leading * in docstrings of defcustoms.
From: |
Chong Yidong |
Subject: |
Re: Leading * in docstrings of defcustoms. |
Date: |
Mon, 24 Nov 2008 18:21:42 -0500 |
User-agent: |
Gnus/5.13 (Gnus v5.13) Emacs/23.0.60 (gnu/linux) |
"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).
- Leading * in docstrings of defcustoms., Lute Kamstra, 2008/11/22
- Re: Leading * in docstrings of defcustoms., Juanma Barranquero, 2008/11/22
- Re: Leading * in docstrings of defcustoms., Glenn Morris, 2008/11/24
- Re: Leading * in docstrings of defcustoms., Juanma Barranquero, 2008/11/24
- Re: Leading * in docstrings of defcustoms., Stefan Monnier, 2008/11/24
- RE: Leading * in docstrings of defcustoms., Drew Adams, 2008/11/24
- Re: Leading * in docstrings of defcustoms., Chong Yidong, 2008/11/24
- RE: Leading * in docstrings of defcustoms., Drew Adams, 2008/11/24
- Re: Leading * in docstrings of defcustoms.,
Chong Yidong <=
- Re: Leading * in docstrings of defcustoms., Stephen J. Turnbull, 2008/11/24
- Re: Leading * in docstrings of defcustoms., Lute Kamstra, 2008/11/25
- Re: Leading * in docstrings of defcustoms., Lute Kamstra, 2008/11/28
- Re: Leading * in docstrings of defcustoms., Juanma Barranquero, 2008/11/28