diff options
Diffstat (limited to 'lisp/gnus')
-rw-r--r-- | lisp/gnus/gnus-agent.el | 4 | ||||
-rw-r--r-- | lisp/gnus/gnus-bookmark.el | 4 | ||||
-rw-r--r-- | lisp/gnus/gnus-fun.el | 3 | ||||
-rw-r--r-- | lisp/gnus/gnus-group.el | 6 | ||||
-rw-r--r-- | lisp/gnus/gnus-score.el | 4 | ||||
-rw-r--r-- | lisp/gnus/gnus-sum.el | 9 | ||||
-rw-r--r-- | lisp/gnus/nnvirtual.el | 8 |
7 files changed, 24 insertions, 14 deletions
diff --git a/lisp/gnus/gnus-agent.el b/lisp/gnus/gnus-agent.el index 961965d9284..19d05120045 100644 --- a/lisp/gnus/gnus-agent.el +++ b/lisp/gnus/gnus-agent.el @@ -1323,7 +1323,7 @@ downloaded into the agent." (gnus-agent-set-local group agent-min (1- active-min))))))) (defun gnus-agent-save-group-info (method group active) - "Update a single group's active range in the agent's copy of the server's active file." + "Update single group's active range in agent's copy of server's active file." (when (gnus-agent-method-p method) (let* ((gnus-command-method (or method gnus-command-method)) (coding-system-for-write nnheader-file-coding-system) @@ -1356,7 +1356,7 @@ downloaded into the agent." (delete-char 1))))))) (defun gnus-agent-get-group-info (method group) - "Get a single group's active range in the agent's copy of the server's active file." + "Get single group's active range in agent's copy of server's active file." (when (gnus-agent-method-p method) (let* ((gnus-command-method (or method gnus-command-method)) (coding-system-for-write nnheader-file-coding-system) diff --git a/lisp/gnus/gnus-bookmark.el b/lisp/gnus/gnus-bookmark.el index 8c2a928ab98..83e482f14c1 100644 --- a/lisp/gnus/gnus-bookmark.el +++ b/lisp/gnus/gnus-bookmark.el @@ -198,7 +198,9 @@ So the cdr of each bookmark is an alist too.") (defun gnus-bookmark-make-record (group message-id author date subject annotation) - "Return the record part of a new bookmark, given GROUP MESSAGE-ID AUTHOR DATE SUBJECT and ANNOTATION." + "Return the record part of a new bookmark. +Arguments GROUP MESSAGE-ID AUTHOR DATE SUBJECT and ANNOTATION +will be saved in the bookmark." (let ((the-record `((group . ,(substring-no-properties group)) (message-id . ,(substring-no-properties message-id)) diff --git a/lisp/gnus/gnus-fun.el b/lisp/gnus/gnus-fun.el index bfc57a2d605..0754d7aa7b8 100644 --- a/lisp/gnus/gnus-fun.el +++ b/lisp/gnus/gnus-fun.el @@ -97,7 +97,8 @@ PNG format." ;;;###autoload (defun gnus--random-face-with-type (dir ext omit fun) - "Return file from DIR with extension EXT, omitting matches of OMIT, processed by FUN." + "Return file from DIR with extension EXT. +Omit matches of OMIT, and process them by FUN." (when (file-exists-p dir) (let* ((files (remove nil (mapcar diff --git a/lisp/gnus/gnus-group.el b/lisp/gnus/gnus-group.el index aea8cbbf78c..b1e486b0627 100644 --- a/lisp/gnus/gnus-group.el +++ b/lisp/gnus/gnus-group.el @@ -4062,7 +4062,8 @@ of groups killed." (if (< (length out) 2) (car out) (nreverse out)))) (defun gnus-group-yank-group (&optional arg) - "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it before the current newsgroup. + "Yank the last newsgroups killed with \\[gnus-group-kill-group], inserting it +before the current newsgroup. The numeric ARG specifies how many newsgroups are to be yanked. The name of the newsgroup yanked is returned, or (if several groups are yanked) a list of yanked groups is returned." @@ -4716,7 +4717,8 @@ or `gnus-group-catchup-group-hook'." (gnus-group-get-parameter group 'timestamp t)) (defun gnus-group-timestamp-delta (group) - "Return the offset in seconds from the timestamp for GROUP to the current time, as a floating point number." + "Return the offset in seconds from the timestamp for GROUP to the current time. +Return value is a floating point number." ;; FIXME: This should return a Lisp integer, not a Lisp float, ;; since it is always an integer. (let* ((time (or (gnus-group-timestamp group) 0)) diff --git a/lisp/gnus/gnus-score.el b/lisp/gnus/gnus-score.el index 0626e8bde5c..e0ad9f698d3 100644 --- a/lisp/gnus/gnus-score.el +++ b/lisp/gnus/gnus-score.el @@ -3115,7 +3115,9 @@ If ADAPT, return the home adaptive file instead." ;;; (defun gnus-decay-score (score) - "Decay SCORE according to `gnus-score-decay-constant' and `gnus-score-decay-scale'." + "Decay SCORE according to decay variables. +The decay variables are `gnus-score-decay-constant' and +`gnus-score-decay-scale'." (floor (- score (* (if (< score 0) -1 1) (min (abs score) diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index 2ddd3d2a7e0..b3d0460032d 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -4357,7 +4357,8 @@ If SELECT-ARTICLES, only select those articles from GROUP." result)) (defun gnus-sort-gathered-threads (threads) - "Sort subthreads inside each gathered thread by `gnus-sort-gathered-threads-function'." + "Sort subthreads inside each gathered thread. +Sorting is done by `gnus-sort-gathered-threads-function'." (let ((result threads)) (while threads (when (stringp (caar threads)) @@ -5173,7 +5174,7 @@ Unscored articles will be counted as having a score of zero." (gnus-article-sort-by-number h1 h2)) (defun gnus-thread-sort-by-most-recent-number (h1 h2) - "Sort threads such that the thread with the most recently arrived article comes first." + "Sort threads such that the thread with most recently arrived article is first." (> (gnus-thread-highest-number h1) (gnus-thread-highest-number h2))) (defun gnus-thread-highest-number (thread) @@ -5187,7 +5188,7 @@ Unscored articles will be counted as having a score of zero." (gnus-article-sort-by-date h1 h2)) (defun gnus-thread-sort-by-most-recent-date (h1 h2) - "Sort threads such that the thread with the most recently dated article comes first." + "Sort threads such that the thread with most recently dated article is first." (> (gnus-thread-latest-date h1) (gnus-thread-latest-date h2))) (defsubst gnus-article-sort-by-newsgroups (h1 h2) @@ -5651,7 +5652,7 @@ or a straight list of headers." gnus-list-identifiers))) (defun gnus-summary-remove-list-identifiers () - "Remove list identifiers in `gnus-list-identifiers' from articles in the current group." + "Remove identifiers in `gnus-list-identifiers' from articles in current group." (let ((regexp (gnus-group-get-list-identifiers gnus-newsgroup-name)) changed subject) (when regexp diff --git a/lisp/gnus/nnvirtual.el b/lisp/gnus/nnvirtual.el index 03a0ff296f2..4136392c825 100644 --- a/lisp/gnus/nnvirtual.el +++ b/lisp/gnus/nnvirtual.el @@ -382,7 +382,8 @@ It is computed from the marks of individual component groups.") (defun nnvirtual-update-xref-header (group article prefix sysname) - "Edit current NOV header in current buffer to have an xref to the component group, and also server prefix any existing xref lines." + "Edit current NOV header in current buffer to have an xref to the component +group, and also server prefix any existing xref lines." ;; Move to beginning of Xref field, creating a slot if needed. (beginning-of-line) (looking-at @@ -569,7 +570,8 @@ If UPDATE-P is not nil, call gnus-group-update-group on the components." ;; unique reverse mapping. (defun nnvirtual-map-article (article) - "Return a cons of the component group and article corresponding to the given virtual ARTICLE." + "Return a cons of the component group and article corresponding to the given +virtual ARTICLE." (let ((table nnvirtual-mapping-table) entry group-pos) (while (and table @@ -590,7 +592,7 @@ If UPDATE-P is not nil, call gnus-group-update-group on the components." (defun nnvirtual-reverse-map-article (group article) - "Return the virtual article number corresponding to the given component GROUP and ARTICLE." + "Return virtual article number corresponding to component GROUP and ARTICLE." (when (numberp article) (let ((table nnvirtual-mapping-table) (group-pos 0) |