1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-05 19:31:02 -08:00

Checkdoc fixes in gnus/*.el

* lisp/gnus/gnus-agent.el (gnus-agent-enable-expiration)
(gnus-agent-with-refreshed-group, gnus-agentize)
(gnus-agent-fetch-headers, gnus-agent-update-files-total-fetched-for)
(gnus-agent-update-view-total-fetched-for):
* lisp/gnus/gnus-art.el (gnus-article-address-banner-alist)
(gnus-default-article-saver, gnus-mime-view-part-as-charset)
(gnus-block-private-groups, gnus-article-edit-mode):
* lisp/gnus/gnus-dired.el (gnus-dired-mode, gnus-dired-attach)
(gnus-dired-find-file-mailcap, gnus-dired-print):
* lisp/gnus/gnus-msg.el (gnus-summary-attach-article):
* lisp/gnus/gnus-score.el (gnus-home-score-file):
* lisp/gnus/gnus-search.el (gnus-search-ignored-newsgroups)
(gnus-search-mu-switches, gnus-search-mu-remove-prefix)
(gnus-search-thread):
* lisp/gnus/gnus-sieve.el (gnus-sieve-string-list):
* lisp/gnus/message.el (message-beginning-of-line):
* lisp/gnus/mm-url.el:
* lisp/gnus/mm-view.el (mm-w3m-setup, mm-setup-w3m):
* lisp/gnus/mml-sec.el (mml-signencrypt-style):
* lisp/gnus/nndiary.el:
* lisp/gnus/nnimap.el (nnimap-server-port, nnimap-use-namespaces)
(nnimap-expunge):
* lisp/gnus/nnmail.el (nnmail-incoming-coding-system):
(nnmail-ignore-broken-references):
* lisp/gnus/nnmairix.el (nnmairix-default-group):
* lisp/gnus/nntp.el (nntp-report):
* lisp/gnus/nnvirtual.el (nnvirtual-update-read-and-marked):
(nnvirtual-partition-sequence):
* lisp/gnus/spam-stat.el (spam-stat-process-directory-age)
(spam-stat-last-saved-at, spam-stat-save):
* lisp/gnus/spam.el (spam-enter-ham-BBDB, spam-check-BBDB):
Checkdoc fixes.
This commit is contained in:
Stefan Kangas 2024-07-08 17:07:03 +02:00
parent 7350457c79
commit e19fd6a22d
19 changed files with 84 additions and 88 deletions

View file

@ -153,7 +153,7 @@ this limit."
When set to ENABLE, the default, `gnus-agent-expire' will expire old
contents from a group's local storage. This value may be overridden
to disable expiration in specific categories, topics, and groups. Of
course, you could change gnus-agent-enable-expiration to DISABLE then
course, you could change `gnus-agent-enable-expiration' to DISABLE then
enable expiration per categories, topics, and groups."
:version "22.1"
:group 'gnus-agent
@ -275,14 +275,14 @@ Actually a hash table holding subjects mapped to t.")
;;;
(defmacro gnus-agent-with-refreshed-group (group &rest body)
"Performs the body then updates the group's line in the group
buffer. Automatically blocks multiple updates due to recursion."
"Perform the body then update the group's line in the group buffer.
Automatically block multiple updates due to recursion."
`(prog1 (let ((gnus-agent-inhibit-update-total-fetched-for t)) ,@body)
(when (and gnus-agent-need-update-total-fetched-for
(not gnus-agent-inhibit-update-total-fetched-for))
(with-current-buffer gnus-group-buffer
(setq gnus-agent-need-update-total-fetched-for nil)
(gnus-group-update-group ,group t)))))
(with-current-buffer gnus-group-buffer
(setq gnus-agent-need-update-total-fetched-for nil)
(gnus-group-update-group ,group t)))))
(defun gnus-agent-read-file (file)
"Load FILE and do a `read' there."
@ -618,8 +618,8 @@ manipulated as follows:
(defun gnus-agentize ()
"Allow Gnus to be an offline newsreader.
The gnus-agentize function is now called internally by gnus when
gnus-agent is set. If you wish to avoid calling gnus-agentize,
The `gnus-agentize' function is now called internally by gnus when
`gnus-agent' is set. If you wish to avoid calling `gnus-agentize',
customize `gnus-agent' to nil.
This will modify the `gnus-setup-news-hook', and
@ -1785,9 +1785,9 @@ variables. Returns the first non-nil value found."
(agent-predicate . gnus-agent-predicate)))))))
(defun gnus-agent-fetch-headers (group)
"Fetch interesting headers into the agent. The group's overview
file will be updated to include the headers while a list of available
article numbers will be returned."
"Fetch interesting headers into the agent.
The group's overview file will be updated to include the headers while a
list of available article numbers will be returned."
(let* ((fetch-all (and gnus-agent-consider-all-articles
;; Do not fetch all headers if the predicate
;; implies that we only consider unread articles.
@ -4059,8 +4059,7 @@ CLEAN is obsolete and ignored."
(defun gnus-agent-update-files-total-fetched-for (group delta
&optional method path)
"Update, or set, the total disk space used by the articles that the
agent has fetched."
"Update or set total disk space used by articles that the agent has fetched."
(when gnus-agent-total-fetched-hashtb
(gnus-agent-with-refreshed-group
group
@ -4099,9 +4098,8 @@ agent has fetched."
(defun gnus-agent-update-view-total-fetched-for
(group agent-over &optional method path)
"Update, or set, the total disk space used by the .agentview and
.overview files. These files are calculated separately as they can be
modified."
"Update or set the total disk space used by the .agentview and .overview files.
These files are calculated separately as they can be modified."
(when gnus-agent-total-fetched-hashtb
(gnus-agent-with-refreshed-group
group