Bug 1737 - Bayesian documentation is weak
Summary: Bayesian documentation is weak
Status: RESOLVED FIXED
Alias: None
Product: Spamassassin
Classification: Unclassified
Component: Documentation (show other bugs)
Version: SVN Trunk (Latest Devel Version)
Hardware: All All
: P5 minor
Target Milestone: 2.54
Assignee: SpamAssassin Developer Mailing List
URL: http://bugs.debian.org/cgi-bin/bugrep...
Whiteboard:
Keywords: backport
Depends on:
Blocks:
 
Reported: 2003-04-03 18:10 UTC by spamassassin
Modified: 2003-05-01 15:17 UTC (History)
0 users



Attachment Type Modified Status Actions Submitter/CLA Status
patch for doco to make it clear how to use Bayes patch None Justin Mason [HasCLA]

Note You need to log in before you can comment on or make changes to this bug.
Description spamassassin 2003-04-03 18:10:47 UTC
From: Bill Wohler <wohler@newt.com>
Subject: spamassassin: Bayesian documentation weak
Date: Mon, 17 Mar 2003 16:57:01 -0800

Package: spamassassin
Version: 2.50-1
Severity: normal

  I just submitted the following to debian-user, but I thought the
  upstream spamassassin folks might be interesting in getting this
  feedback too:

  Compare the spamassassin Bayesian documentation with that
  documentation in the spamprobe and bogofilter man pages.

				 -----

  It wasn't clear to me from the man page that you could build a "good"
  word lists as well as a "spam" word list. The man page implies that
  only a spam word list would get generated with -r and these words
  would be removed with -k, which doesn't work at all. Nor did the man
  page suggest how to prime the database with "good" and "bad" messages.
  I was leery of the -k option since I don't want my personal mail going
  to the Razor (although I think the --local option could be used to
  suppress that). The man page didn't mention whether the database was
  updated every time spamassassin was called or not.

  Thus, the man page raises more questions than it answers and implies a
  suspect implementation.
Comment 1 Justin Mason 2003-04-04 14:20:34 UTC
right, take a look at this for a fix.  Also fixed the --ham and --spam args to
sa-learn not indicating that they auto-forget, BTW.
Comment 2 Justin Mason 2003-04-04 14:21:37 UTC
Created attachment 861 [details]
patch for doco to make it clear how to use Bayes
Comment 3 Duncan Findlay 2003-04-04 18:55:54 UTC
Looks good... even more documentation would be nice, but really it's not a huge
priority.
Comment 4 Theo Van Dinter 2003-04-04 19:47:35 UTC
OKAY: looks good to me
Comment 5 Justin Mason 2003-04-04 20:04:35 UTC
re: more doco -- Yeah, I was looking for basic concepts I'd missed, but couldn't
really see any... suggestions? patches? ;)
Comment 6 Duncan Findlay 2003-04-04 23:07:28 UTC
Subject: Re:  Bayesian documentation is weak

> re: more doco -- Yeah, I was looking for basic concepts I'd missed, but couldn't
> really see any... suggestions? patches? ;)

I think at some point we're going to have to go through and
restructure and do some major fixing up of the docs -- a lot of it
could use some improvement.

I might think about doing this sometime soon.

Comment 7 Theo Van Dinter 2003-04-23 21:53:21 UTC
so what do we want to do with this bug?  is the patch good enough, should there
be more?
Comment 8 Daniel Quinlan 2003-04-26 02:02:24 UTC
OKAY: if you want to apply, fine with me

If we only want to apply this to head and leave 2.5x alone, that's also fine
with me as long as it's in HEAD.
Comment 9 Justin Mason 2003-05-01 23:17:10 UTC
ok, applied