From: Jonas Steverud <tvrud@bredband.net>
Subject: Regarding spam.el
Date: Tue, 09 Mar 2004 14:49:22 +0100 [thread overview]
Message-ID: <m2oer68719.fsf@c-9f5372d5.036-4-67626721.cust.bredbandsbolaget.se> (raw)
1. Is gnus-group-*-exit-processor-bogofilter obsolete? If so, it
should be better marked as such in the info file. Same for all
similar obsolete variables.
2. In "Spam ELisp Package Sequence of Events": Second half of fifth
paragraph: The `spam-autodetect' and
`spam-autodetect-methods'... Yes, what about them? First half
of the paragrapg is clear, then a bunch of parameters and
varaibles comes out of the blue. What are they used for? What
can they be set to? The reader only gets confused. Either a
reference to a info node or explaination text is needed.
The paragraph after explains it but not very clear. An example
woul be very nice.
3. There are several group parameters and variables mentioned in the
info file and it is not always obvious which is which. A separate
page/node or at the end of one of the nodes with a list of all
variables and the corresponding parameters with examples would be a
good idea.
4. How do I tell Gnus that nnfolder:Spam is my spam group and that all
other groups are ham? There a number of references to a
spam-contents variable/parameter but I got all confused trying to
figure out what to set it to. And where. Several parts of the info
nodes only lists what parameters and variables there are but not
what I set them to, what values that are valid.
5. The following paragraph from "Spam ELisp Package Global Variables"
is typical for the entire documentation:
"When you leave a _spam_ group, all spam-marked articles are marked
as expired after processing with the spam processor. This is not done
for _unclassified_ or _ham_ groups. Also, any *ham* articles in a spam
group will be moved to a location determined by either the
`ham-process-destination' group parameter or a match in the
`gnus-ham-process-destinations' variable, which is a list of regular
expressions matched with group names (it's easiest to customize this
variable with `customize-variable gnus-ham-process-destinations'). Each
newsgroup specification has the format (REGEXP PROCESSOR) in a standard
Lisp list, if you prefer to customize the variable manually. The
ultimate location is a group name or names. If the
`ham-process-destination' parameter is not set, ham articles are left
in place. If the `spam-mark-ham-unread-before-move-from-spam-group'
parameter is set, the ham articles are marked as unread before being
moved."
a. The author gets sidetracked by his own willingness to explain
and help the reader, e.g. the "(it's easiest to customize...)"
part. It is not uncommon that when the author explains what
something is, he then tells the reader how to set the
variable/parameter ("use M-x customize-..." or "...G c or G p as
usual"). These lengthy side notes cuts up the flow of the text
and starts to annoy the reader when he reads it for the
umpteenth time. Better to state in the beginning of the Spam
nodes that these fascillities can be used and when a reminder is
needed, add a short reminder that doesn't side track the reader.
b. The explaination of (gnus-)ham-process-destinations is not
complete and even confusing. It is a list of regexp matched with
group names. In the next sentance it is declared as a (REGEXP
PROCESSOR). That is not a list of regexps, it is a list of lists
that contains a regexp and a PROCESSOR. What this PROCESSOR is
not explained.
c. The given information is not consistent with information given a
bit further down the page:
"When you leave a _ham_ or _unclassified_ group, all *spam* articles
are moved to a location determined by either the
`spam-process-destination' group parameter or a match in the
`gnus-spam-process-destinations' variable, which is a list of regular
expressions matched with group names (it's easiest to customize this
variable with `customize-variable gnus-spam-process-destinations').
Each newsgroup specification has the repeated format (REGEXP GROUP) and
they are all in a standard Lisp list, if you prefer to customize the
variable manually. The ultimate location is a group name or names. If
the `spam-process-destination' parameter is not set, the spam articles
are only expired. The group name is fully qualified, meaning that if
you see `nntp:servername' before the group name in the group buffer
then you need it here as well."
Here the parameter is a list of (REGEXP GROUP). What is the
REGEXP matched on?
d. In the example section gives the following example:
((spam-process-destination . "nnimap+mail.lifelogs.com:train"))
When did a string become a (REGEXP PROCESSOR) or (REGEXP GROUP)?
Same goes for
(ham-process-destination "nnimap+mail.lifelogs.com:mail"
"nnimap+mail.lifelogs.com:trainham")
Summary:
The entire documentation needs to be fleshed out with examples and
a better flow of text. At some places it is more or less just a long
list of variable and parameter names which is as penetrable as a
brick wall.
I'm willing to help with this, but I need to understand how it works
before I can do anything about it.
--
( http://hem.bredband.net/steverud/ ! Wei Wu Wei )
( Meaning of U2 Lyrics, Roleplaying ! To Do Without Do )
next reply other threads:[~2004-03-09 13:49 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2004-03-09 13:49 Jonas Steverud [this message]
2004-03-09 19:55 ` Russ Allbery
2004-03-09 23:34 ` Jonas Steverud
2004-03-29 22:12 ` Ted Zlatanov
2004-03-29 22:14 ` Ted Zlatanov
2004-03-29 22:11 ` Ted Zlatanov
2004-04-03 9:58 ` Jonas Steverud
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=m2oer68719.fsf@c-9f5372d5.036-4-67626721.cust.bredbandsbolaget.se \
--to=tvrud@bredband.net \
/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).