bug#39780: [PATCH] Mention 'spam-stat-process-directory-age' in the documentation

bug#39780: [PATCH] Mention 'spam-stat-process-directory-age' in the documentation

[Štěpán Němec]

I was at a loss as to why my attempt to set up spam-stat seemed to
have no effect, only to find (digging in the code) that it was
ignoring most of the sample files due to this undocumented variable.

* doc/misc/gnus.texi (Creating a spam-stat dictionary): Document
the variable 'spam-stat-process-directory-age'.
---
 doc/misc/gnus.texi | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
index 424e15bc6d..718e269fc8 100644
--- a/doc/misc/gnus.texi
+++ b/doc/misc/gnus.texi
@@ -25668,6 +25668,13 @@ Creating a spam-stat dictionary
 file is treated as one non-spam mail.
 @end defun
 
+@defvar spam-stat-process-directory-age
+Maximum age of files to be processed, in days.  Without this filter,
+re-training spam-stat with several thousand messages could take a long
+time.  The default is 90, but you might want to set this to a bigger
+value during the initial training.
+@end defvar
+
 Usually you would call @code{spam-stat-process-spam-directory} on a
 directory such as @file{~/Mail/mail/spam} (this usually corresponds to
 the group @samp{nnml:mail.spam}), and you would call
-- 
2.25.1

bug#39780: [PATCH] Mention 'spam-stat-process-directory-age' in the documentation

[Štěpán Němec]

On Tue, 25 Feb 2020 13:58:12 +0100
Štěpán Němec wrote:

> I was at a loss as to why my attempt to set up spam-stat seemed to
> have no effect, only to find (digging in the code) that it was
> ignoring most of the sample files due to this undocumented variable.
>
> * doc/misc/gnus.texi (Creating a spam-stat dictionary): Document
> the variable 'spam-stat-process-directory-age'.
> ---
>  doc/misc/gnus.texi | 7 +++++++
>  1 file changed, 7 insertions(+)
>
> diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi
> index 424e15bc6d..718e269fc8 100644
> --- a/doc/misc/gnus.texi
> +++ b/doc/misc/gnus.texi
> @@ -25668,6 +25668,13 @@ Creating a spam-stat dictionary
>  file is treated as one non-spam mail.
>  @end defun
>  
> +@defvar spam-stat-process-directory-age
> +Maximum age of files to be processed, in days.  Without this filter,
> +re-training spam-stat with several thousand messages could take a long
> +time.  The default is 90, but you might want to set this to a bigger
> +value during the initial training.
> +@end defvar
> +
>  Usually you would call @code{spam-stat-process-spam-directory} on a
>  directory such as @file{~/Mail/mail/spam} (this usually corresponds to
>  the group @samp{nnml:mail.spam}), and you would call

Any reason not to include this in emacs-27?

-- 
Štěpán

bug#39780: [PATCH] Mention 'spam-stat-process-directory-age' in the documentation

[Eli Zaretskii]

> From: Štěpán Němec
>  <stepnem@gmail.com>
> Date: Sat, 18 Apr 2020 13:51:55 +0200
> 
> Any reason not to include this in emacs-27?

Documentation changes are always OK on the release branch, if they
pertain to features that exist on the branch.

Thanks.

bug#39780: [PATCH] Mention 'spam-stat-process-directory-age' in the documentation

[Štěpán Němec]

On Sat, 18 Apr 2020 15:29:46 +0300
Eli Zaretskii wrote:

>> Any reason not to include this in emacs-27?
>
> Documentation changes are always OK on the release branch, if they
> pertain to features that exist on the branch.

Thank you; pushed to emacs-27:

2019-07-31T09:51:09+02:00!stepnem@gmail.com
52288f4b66 (Mention 'spam-stat-process-directory-age' in the documentation)
https://git.sv.gnu.org/cgit/emacs.git/commit/?id=52288f4b66

-- 
Štěpán