Documentation unclear? nnimap `variables'

Documentation unclear? nnimap `variables'

[Kai Großjohann]

Look at this:

/----[ C-h v nnimap-authenticator RET ]
| nnimap-authenticator's value is nil
| 
| Documentation:
| How nnimap authenticate itself to the server.
| 
| The default, nil, will try to use the "best" method the server can
| handle.
| 
| There is only one reason for fiddling with this variable, and that is
| if your server is more capable than your environment -- i.e. you
| connect to a server that accept Kerberos login's but you haven't
| installed the `imtest' program or your machine isn't configured for
| Kerberos.
| 
| Possible choices: kerberos4, cram-md5, login, anonymous.
| 
| Defined in `nnimap'.
\----

/----[ C-h v nnimap-expunge-on-close RET ]
| nnimap-expunge-on-close's value is always
| 
| Documentation:
| Whether to expunge a group when it is closed.
| When a IMAP group with articles marked for deletion is closed, this
| variable determine if nnimap should actually remove the articles or
| not.
| 
| If always, nnimap always perform a expunge when closing the group.
| If never, nnimap never expunges articles marked for deletion.
| If ask, nnimap will ask you if you wish to expunge marked articles.
| 
| When setting this variable to `never', you can only expunge articles
| by using `G x' (gnus-group-nnimap-expunge) from the Group buffer.
| 
| Defined in `nnimap'.
\----

I think one of them is a server parameter, and the other is a normal
variable?

[time passes]

Oh, the code tells me they're both defvoo's, so probably they're both
server parameters.  But nnimap-authinfo-file is a normal variable.

But the documentation does not make this clear at all.

IMVHO the defvoo's should make it clear in the documentation that they
should be set as server parameters.  Probably similar confusion exists
in other backends.  What do you think?

kai
-- 
~/.signature: No such file or directory