From: Simon Josefsson <jas@extundo.com>
Subject: Server variable documentation
Date: Sun, 09 Dec 2001 01:44:35 +0100 [thread overview]
Message-ID: <iluy9kdw7bg.fsf@dhcp128.extundo.com> (raw)
It was pointed out that nnimap.el didn't have the doc string for
variables that some other backends (nnbabyl.el, nnfolder.el,
nnmbox.el, nnmh.el, and nnml.el) has:
,----
| (defvoo nnml-directory message-directory
| "Spool directory for the nnml mail backend.
|
| This variable is a virtual server slot. See the Gnus manual for details.")
`----
Perhaps we can do something less manual than modifying the remaining
nn*.el files with the following patch. Not only do you get a fancy
hyperlink to the proper section in the manual, but the documentation
is added automatically, and it uses the term "server variable" which I
think is more in line with what the Gnus documentation uses. Of
course, the previous doc string patch has to be reverted.
What'ya'think? Maybe `deffoo' should have this as well.
--- nnoo.el.~6.4.~ Tue Nov 6 18:06:50 2001
+++ nnoo.el Sun Dec 9 01:37:59 2001
@@ -38,7 +38,7 @@
"The same as `defvar', only takes list of variables to MAP to."
`(prog1
,(if doc
- `(defvar ,var ,init ,doc)
+ `(defvar ,var ,init ,(concat doc "\n\nThis is a Gnus server variable. See Info node `(gnus)Select Methods'."))
`(defvar ,var ,init))
(nnoo-define ',var ',map)))
(put 'defvoo 'lisp-indent-function 2)
next reply other threads:[~2001-12-09 0:44 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2001-12-09 0:44 Simon Josefsson [this message]
2001-12-09 15:32 ` Kai Großjohann
2001-12-12 20:25 ` Simon Josefsson
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=iluy9kdw7bg.fsf@dhcp128.extundo.com \
--to=jas@extundo.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).