Re: Double hyphens in variable names.

[Lute Kamstra <Lute.Kamstra@cwi.nl>]

Luc Teirlinck <teirllm@dms.auburn.edu> writes:

> Lute Kamstra wrote:
>
>    Imenu's functionality can be easily explained without referring to
>    imenu--info-alist, so I think I'll do that.
>
> After reading things in somewhat more detail, it seems that you still
> describe `imenu--info-alist' in as much detail as before, you just do
> not mention its name.  I believe it would be better if you at least
> mentioned that the return value of `imenu-create-index-function' is
> stored in @code{imenu--info-alist}.  I believe that, as the return
> value of `imenu-create-index-function', `imenu--info-alist' is not an
> internal variable.  Strictly speaking, it should not have the two
> consecutive dashes in its name.

When writing a major mode, you should never set imenu--index-alist
directly; nor should you have to use its value.  So it is not part of
Imenu's interface and therefore it is an internal variable.

  Lute.