[redirected to xemacs-beta]
"Stephen J. Turnbull" <stephen(a)xemacs.org> writes:
>>>>> "jas" == CVS Monitor
<xemacs-cvs(a)xemacs.org> writes:
jas> 2002-03-15 Simon Josefsson <jas(a)extundo.com>
jas> * browse-url.el (browse-url-filename-alist): Don't
jas> begin docstring with *, you don't want to set this one with
jas> M-x set-variable.
But you do want to see it in the C-h a list.
It does show up there, just not marked with an asterix.
I think anything that's Customizable should be considered a user
variable.
The Emacs Lisp Referance manual contains some info on this:
- Macro: defcustom option default doc [keyword value]...
Declare OPTION as a customizable user option variable. Do not
quote OPTION. The argument DOC specifies the documentation string
for the variable. It should often start with a `*' to mark it as
a "user option" (*note Defining Variables::). Do not start the
documentation string with `*' for options which cannot or normally
should not be set with `set-variable'; examples of the former are
global minor mode options such as `global-font-lock-mode' and
examples of the latter are hooks.
I can't find anything similar in XEmacs, but I think it would be nice
if the same docstring rules applied to both emacsen. Maybe the above
could be added to the XEmacs elisp manual?