Re: doc-strings beginning with "*"
Charles G Waldman <cgw(a)fnal.gov> wrote:
Am I correct in assuming that this is a mistake?
No.
Someone put in "*" at the beginning of the comment not
realizing that it
would go into the docstring?
Clever, I wouldn't have thought of this :-)
Or does the "*" at the beginning of the docstring have some
meaning?
Yes. From the info node of defvar:
,----
| If the first character of DOC-STRING is `*', it means that this
| variable is considered a user option. This lets users set the
| variable conveniently using the commands `set-variable' and
| `edit-options'.
`-----
The usage of the star is often somewhat abusive though.
--
/ / _ _ Didier Verna http://www.inf.enst.fr/~verna/
- / / - / / /_/ / ENST, INFRES C201.1 mailto:vernaļ¼ inf.enst.fr
/_/ / /_/ / /__ / 46 rue Barrault Tel. +33 (1) 45 81 73 46
75013 Paris, France Fax. +33 (1) 45 81 31 19