Commit 3042deef authored by Juanma Barranquero's avatar Juanma Barranquero
Browse files

(spam-find-spam, spam-enter-list): Doc fixes.

(spam-split-symbolic-return-positive): Reflow docstring.
(spam-backends, spam-summary-exit-behavior,
spam-mark-ham-unread-before-move-from-spam-group,
spam-summary-score-preferred-header, spam-sa-learn-spam-switch,
spam-sa-learn-ham-switch, spam-sa-learn-unregister-switch, spam-clear-cache,
spam-backend-check, spam-install-backend, spam-install-statistical-backend,
spam-list-of-processors, spam-group-processor-p, spam-split,
spam-bogofilter-score, spam-bsfilter-score, spam-check-bsfilter,
spam-crm114-score, spam-check-crm114, spam-initialize, spam-unload-hook):
Fix typos in docstrings.
parent 967c6c49
2007-11-22 Juanma Barranquero <lekktu@gmail.com>
* spam.el (spam-find-spam, spam-enter-list): Doc fixes.
(spam-split-symbolic-return-positive): Reflow docstring.
(spam-backends, spam-summary-exit-behavior)
(spam-mark-ham-unread-before-move-from-spam-group)
(spam-summary-score-preferred-header, spam-sa-learn-spam-switch)
(spam-sa-learn-ham-switch, spam-sa-learn-unregister-switch)
(spam-clear-cache, spam-backend-check, spam-install-backend)
(spam-install-statistical-backend, spam-list-of-processors)
(spam-group-processor-p, spam-split, spam-bogofilter-score)
(spam-bsfilter-score, spam-check-bsfilter, spam-crm114-score)
(spam-check-crm114, spam-initialize, spam-unload-hook):
Fix typos in docstrings.
2007-11-21 Reiner Steib <Reiner.Steib@gmx.de>
* message.el (message-send-mail-function): Require sendmail.
......@@ -10491,7 +10506,7 @@
eval-when-compile, to define gnus-agent-set-cat-groups as the setf
method of gnus-agent-cat-groups even when the buffer has been
evaled.
(gnus-agent-save-active,gnus-agent-save-active-1): Merged to
(gnus-agent-save-active, gnus-agent-save-active-1): Merged to
delete gnus-agent-save-active-1.
(gnus-agent-save-groups): Deleted. Identical to
gnus-agent-save-active.
......@@ -10502,12 +10517,12 @@
servers. Add use of min/max range limits from server's local
file.
(gnus-agent-save-alist): Removed unused optional argument.
(gnus-agent-load-local,gnus-agent-read-and-cache-local),
(gnus-agent-read-local,gnus-agent-save-local,gnus-agent-get-local),
(gnus-agent-load-local, gnus-agent-read-and-cache-local),
(gnus-agent-read-local, gnus-agent-save-local, gnus-agent-get-local),
(gnus-agent-set-local): A per-server file that keeps min/max range
limits for articles known to the agent. Provides a fast mechanism
for altering many active ranges.
(gnus-agent-expire-group,gnus-agent-expire): No longer save the
(gnus-agent-expire-group, gnus-agent-expire): No longer save the
active file (local makes it unnecessary).
(gnus-agent-regenerate-group): Fixed XEmacs compatibility.
......
......@@ -81,7 +81,7 @@
;;{{{ Main parameters.
(defvar spam-backends nil
"List of spam.el backends with all the pertinent data.
Populated by spam-install-backend-super.")
Populated by `spam-install-backend-super'.")
(defgroup spam nil
"Spam configuration."
......@@ -91,7 +91,7 @@ Populated by spam-install-backend-super.")
(defcustom spam-summary-exit-behavior 'default
"Exit behavior at the time of summary exit.
Note that setting the spam-use-move or spam-use-copy backends on
Note that setting the `spam-use-move' or `spam-use-copy' backends on
a group through group/topic parameters overrides this mechanism."
:type '(choice (const 'default :tag
"Move spam out of all groups. Move ham out of spam groups.")
......@@ -124,8 +124,7 @@ a group through group/topic parameters overrides this mechanism."
(defcustom spam-split-symbolic-return-positive nil
"Whether `spam-split' should ALWAYS work with symbols or group names.
Do not set this if you use `spam-split' in a fancy split
method."
Do not set this if you use `spam-split' in a fancy split method."
:type 'boolean
:group 'spam)
......@@ -139,7 +138,7 @@ without losing it to the automatic spam-marking process."
(defcustom spam-mark-ham-unread-before-move-from-spam-group nil
"Whether ham should be marked unread before it's moved.
The article is moved out of a spam group according to ham-process-destination.
The article is moved out of a spam group according to `ham-process-destination'.
This variable is an official entry in the international Longest Variable Name
Competition."
:type 'boolean
......@@ -403,7 +402,7 @@ Only meaningful if you enable `spam-use-regex-body'."
:group 'spam)
(defcustom spam-summary-score-preferred-header nil
"Preferred header to use for spam-summary-score."
"Preferred header to use for `spam-summary-score'."
:type '(choice :tag "Header name"
(symbol :tag "SpamAssassin etc" X-Spam-Status)
(symbol :tag "Bogofilter" X-Bogosity)
......@@ -621,17 +620,17 @@ order for SpamAssassin to recognize the new registered spam."
:group 'spam-spamassassin)
(defcustom spam-sa-learn-spam-switch "--spam"
"The switch that sa-learn uses to register spam messages"
"The switch that sa-learn uses to register spam messages."
:type 'string
:group 'spam-spamassassin)
(defcustom spam-sa-learn-ham-switch "--ham"
"The switch that sa-learn uses to register ham messages"
"The switch that sa-learn uses to register ham messages."
:type 'string
:group 'spam-spamassassin)
(defcustom spam-sa-learn-unregister-switch "--forget"
"The switch that sa-learn uses to unregister messages messages"
"The switch that sa-learn uses to unregister messages messages."
:type 'string
:group 'spam-spamassassin)
......@@ -722,7 +721,7 @@ finds ham or spam.")
;;{{{ convenience functions
(defun spam-clear-cache (symbol)
"Clear the spam-caches entry for a check."
"Clear the `spam-caches' entry for a check."
(remhash symbol spam-caches))
(defun spam-xor (a b)
......@@ -837,7 +836,6 @@ Accepts incoming CHECK, ham registration function HRF, spam
registration function SRF, ham unregistration function HUF, spam
unregistration function SUF, and an indication whether the
backend is STATISTICAL."
(setq spam-backends (add-to-list 'spam-backends backend))
(while properties
(let ((property (pop properties))
......@@ -875,7 +873,7 @@ The value nil means that the check does not yield a decision, and
so, that further checks are needed. The value t means that the
message is definitely not spam, and that further spam checks
should be inhibited. Otherwise, a mailgroup name or the symbol
'spam (depending on spam-split-symbolic-return) is returned where
'spam (depending on `spam-split-symbolic-return') is returned where
the mail should go, and further checks are also inhibited. The
usual mailgroup name is the value of `spam-split-group', meaning
that the message is definitely a spam."
......@@ -1010,7 +1008,7 @@ statistical (it could be, but in practice that doesn't happen)."
Accepts incoming CHECK, ham registration function HRF, spam
registration function SRF, ham unregistration function HUF, spam
unregistration function SUF. The backend won't be
statistical (use spam-install-statistical-backend for that)."
statistical (use `spam-install-statistical-backend' for that)."
(spam-install-backend-super
backend
'check check 'hrf hrf 'srf srf 'huf huf 'suf suf))
......@@ -1020,7 +1018,7 @@ statistical (use spam-install-statistical-backend for that)."
Accepts incoming CHECK, ham registration function HRF, spam
registration function SRF, ham unregistration function HUF, spam
unregistration function SUF. The backend will be
statistical (use spam-install-backend for non-statistical
statistical (use `spam-install-backend' for non-statistical
backends)."
(spam-install-backend-super
backend
......@@ -1287,14 +1285,14 @@ This list contains pairs associating the obsolete ham/spam exit
processor variables with a classification and a spam-use-*
variable. When the processor variable is nil, just the
classification and spam-use-* check variable are used. This is
superceded by the new spam backend code, so it's only consulted
superseded by the new spam backend code, so it's only consulted
for backwards compatibility.")
(defun spam-group-processor-p (group backend &optional classification)
"Checks if GROUP has a BACKEND with CLASSIFICATION registered.
Also accepts the obsolete processors, which can be found in
gnus.el and in spam-list-of-processors. In the case of mover
backends, checks the setting of spam-summary-exit-behavior in
backends, checks the setting of `spam-summary-exit-behavior' in
addition to the set values for the group."
(if (and (stringp group)
(symbolp backend))
......@@ -1621,7 +1619,7 @@ to find it out)."
This function can be used as an entry in the variable `nnmail-split-fancy',
for example like this: (: spam-split). It can take checks as
parameters. A string as a parameter will set the
spam-split-group to that string.
`spam-split-group' to that string.
See the Info node `(gnus)Fancy Mail Splitting' for more details."
(interactive)
......@@ -1673,7 +1671,7 @@ See the Info node `(gnus)Fancy Mail Splitting' for more details."
decision))))))))
(defun spam-find-spam ()
"This function will detect spam in the current newsgroup using spam-split."
"Detect spam in the current newsgroup using `spam-split'."
(interactive)
(let* ((group gnus-newsgroup-name)
......@@ -2311,8 +2309,8 @@ With a non-nil REMOVE, remove them."
(defun spam-enter-list (addresses file &optional remove)
"Enter ADDRESSES into the given FILE.
Either the whitelist or the blacklist files can be used. With
REMOVE not nil, remove the ADDRESSES."
Either the whitelist or the blacklist files can be used.
With a non-nil REMOVE, remove the ADDRESSES."
(if (stringp addresses)
(spam-enter-list (list addresses) file remove)
;; else, we have a list of addresses here
......@@ -2492,7 +2490,7 @@ REMOVE not nil, remove the ADDRESSES."
;; return something sensible if the score can't be determined
(defun spam-bogofilter-score (&optional recheck)
"Get the Bogofilter spamicity score"
"Get the Bogofilter spamicity score."
(interactive "P")
(save-window-excursion
(gnus-summary-show-article t)
......@@ -2736,7 +2734,7 @@ REMOVE not nil, remove the ADDRESSES."
;; return something sensible if the score can't be determined
(defun spam-bsfilter-score (&optional recheck)
"Get the Bsfilter spamicity score"
"Get the Bsfilter spamicity score."
(interactive "P")
(save-window-excursion
(gnus-summary-show-article t)
......@@ -2749,7 +2747,7 @@ REMOVE not nil, remove the ADDRESSES."
(or score "0"))))
(defun spam-check-bsfilter (&optional score)
"Check the Bsfilter backend for the classification of this message"
"Check the Bsfilter backend for the classification of this message."
(let ((article-buffer-name (buffer-name))
(dir spam-bsfilter-database-directory)
return)
......@@ -2823,7 +2821,7 @@ REMOVE not nil, remove the ADDRESSES."
;; return something sensible if the score can't be determined
(defun spam-crm114-score ()
"Get the CRM114 Mailfilter pR"
"Get the CRM114 Mailfilter pR."
(interactive)
(save-window-excursion
(gnus-summary-show-article t)
......@@ -2835,7 +2833,7 @@ REMOVE not nil, remove the ADDRESSES."
(or score "0"))))
(defun spam-check-crm114 (&optional score)
"Check the CRM114 Mailfilter backend for the classification of this message"
"Check the CRM114 Mailfilter backend for the classification of this message."
(let ((article-buffer-name (buffer-name))
(db spam-crm114-database-directory)
return)
......@@ -2897,9 +2895,9 @@ REMOVE not nil, remove the ADDRESSES."
(defun spam-initialize (&rest symbols)
"Install the spam.el hooks and do other initialization.
When SYMBOLS is given, set those variables to t. This is so you
can call spam-initialize before you set spam-use-* variables on
can call `spam-initialize' before you set spam-use-* variables on
explicitly, and matters only if you need the extra headers
installed through spam-necessary-extra-headers."
installed through `spam-necessary-extra-headers'."
(interactive)
(dolist (var symbols)
......@@ -2923,7 +2921,7 @@ installed through spam-necessary-extra-headers."
(add-hook 'gnus-summary-prepared-hook 'spam-find-spam))
(defun spam-unload-hook ()
"Uninstall the spam.el hooks"
"Uninstall the spam.el hooks."
(interactive)
(remove-hook 'gnus-save-newsrc-hook 'spam-maybe-spam-stat-save)
(remove-hook 'gnus-get-top-new-news-hook 'spam-maybe-spam-stat-load)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment