diff options
Diffstat (limited to 'lisp/gnus/nnir.el')
| -rw-r--r-- | lisp/gnus/nnir.el | 55 |
1 files changed, 28 insertions, 27 deletions
diff --git a/lisp/gnus/nnir.el b/lisp/gnus/nnir.el index d66bdf47066..b695cfa4f6d 100644 --- a/lisp/gnus/nnir.el +++ b/lisp/gnus/nnir.el @@ -189,7 +189,7 @@ "Internal: stores search result.") (defvar nnir-search-history () - "Internal: the history for querying search options in nnir") + "Internal: the history for querying search options in nnir.") (defconst nnir-tmp-buffer " *nnir*" "Internal: temporary buffer.") @@ -208,8 +208,8 @@ (defvar nnir-imap-search-other "HEADER %S" "The IMAP search item to use for anything other than - `nnir-imap-search-arguments'. By default this is the name of an - email header field") +`nnir-imap-search-arguments'. By default this is the name of an +email header field.") (defvar nnir-imap-search-argument-history () "The history for querying search options in nnir") @@ -219,48 +219,48 @@ ;; Data type article list. (defmacro nnir-artlist-length (artlist) - "Returns number of articles in artlist." + "Return number of articles in artlist." `(length ,artlist)) (defmacro nnir-artlist-article (artlist n) - "Returns from ARTLIST the Nth artitem (counting starting at 1)." + "Return from ARTLIST the Nth artitem (counting starting at 1)." `(when (> ,n 0) (elt ,artlist (1- ,n)))) (defmacro nnir-artitem-group (artitem) - "Returns the group from the ARTITEM." + "Return the group from the ARTITEM." `(elt ,artitem 0)) (defmacro nnir-artitem-number (artitem) - "Returns the number from the ARTITEM." + "Return the number from the ARTITEM." `(elt ,artitem 1)) (defmacro nnir-artitem-rsv (artitem) - "Returns the Retrieval Status Value (RSV, score) from the ARTITEM." + "Return the Retrieval Status Value (RSV, score) from the ARTITEM." `(elt ,artitem 2)) (defmacro nnir-article-group (article) - "Returns the group for ARTICLE" + "Return the group for ARTICLE." `(nnir-artitem-group (nnir-artlist-article nnir-artlist ,article))) (defmacro nnir-article-number (article) - "Returns the number for ARTICLE" + "Return the number for ARTICLE." `(nnir-artitem-number (nnir-artlist-article nnir-artlist ,article))) (defmacro nnir-article-rsv (article) - "Returns the rsv for ARTICLE" + "Return the rsv for ARTICLE." `(nnir-artitem-rsv (nnir-artlist-article nnir-artlist ,article))) (defsubst nnir-article-ids (article) - "Returns the pair `(nnir id . real id)' of ARTICLE" + "Return the pair `(nnir id . real id)' of ARTICLE." (cons article (nnir-article-number article))) (defmacro nnir-categorize (sequence keyfunc &optional valuefunc) - "Sorts a sequence into categories and returns a list of the form + "Sort a sequence into categories and returns a list of the form `((key1 (element11 element12)) (key2 (element21 element22))'. The category key for a member of the sequence is obtained as `(keyfunc member)' and the corresponding element is just -`member'. If `valuefunc' is non-nil, the element of the list +`member'. If `valuefunc' is non-nil, the element of the list is `(valuefunc member)'." `(unless (null ,sequence) (let (value) @@ -317,7 +317,7 @@ If nil this will use `gnus-summary-line-format'." (defcustom nnir-retrieve-headers-override-function nil "If non-nil, a function that accepts an article list and group and populates the `nntp-server-buffer' with the retrieved -headers. Must return either 'nov or 'headers indicating the +headers. Must return either 'nov or 'headers indicating the retrieved header format. If this variable is nil, or if the provided function returns nil for a search @@ -327,8 +327,8 @@ result, `gnus-retrieve-headers' will be called instead." :group 'nnir) (defcustom nnir-imap-default-search-key "whole message" - "The default IMAP search key for an nnir search. Must be one of - the keys in `nnir-imap-search-arguments'. To use raw imap queries + "The default IMAP search key for an nnir search. Must be one of + the keys in `nnir-imap-search-arguments'. To use raw imap queries by default set this to \"imap\"." :version "24.1" :type `(choice ,@(mapcar (lambda (elem) (list 'const (car elem))) @@ -428,7 +428,7 @@ This could be a server parameter." (defcustom nnir-hyrex-additional-switches '() "A list of strings, to be given as additional arguments for nnir-search. -Note that this should be a list. I.e., do NOT use the following: +Note that this should be a list. I.e., do NOT use the following: (setq nnir-hyrex-additional-switches \"-ddl ddl.xml -c nnir\") ; wrong ! Instead, use this: (setq nnir-hyrex-additional-switches \\='(\"-ddl\" \"ddl.xml\" \"-c\" \"nnir\"))" @@ -600,8 +600,8 @@ the groups to search as follows: if called from the *Server* buffer search all groups belonging to the server on the current line; if called from the *Group* buffer search any marked groups, or the group on the current line, or all the groups under the -current topic. Calling with a prefix-arg prompts for additional -search-engine specific constraints. A non-nil `specs' arg must be +current topic. Calling with a prefix-arg prompts for additional +search-engine specific constraints. A non-nil `specs' arg must be an alist with `nnir-query-spec' and `nnir-group-spec' keys, and skips all prompting." (interactive "P") @@ -1456,8 +1456,9 @@ Tested with swish-e-2.0.1 on Windows NT 4.0." ;; Namazu interface (defun nnir-run-namazu (query server &optional _group) - "Run given query against Namazu. Returns a vector of (group name, file name) -pairs (also vectors, actually). + "Run given query against Namazu. +Returns a vector of (group name, file name) pairs (also vectors, +actually). Tested with Namazu 2.0.6 on a GNU/Linux system." ;; (when group @@ -1702,12 +1703,12 @@ construct path: search terms (see the variable (and group (string-match "^nnir" group)))) (defun nnir-read-parms (nnir-search-engine) - "Reads additional search parameters according to `nnir-engines'." + "Read additional search parameters according to `nnir-engines'." (let ((parmspec (nth 2 (assoc nnir-search-engine nnir-engines)))) (mapcar #'nnir-read-parm parmspec))) (defun nnir-read-parm (parmspec) - "Reads a single search parameter. + "Read a single search parameter. `parmspec' is a cons cell, the car is a symbol, the cdr is a prompt." (let ((sym (car parmspec)) (prompt (cdr parmspec))) @@ -1737,8 +1738,8 @@ construct path: search terms (see the variable nnir-method-default-engines)))) (defun nnir-read-server-parm (key server &optional not-global) - "Returns the parameter value corresponding to `key' for -`server'. If no server-specific value is found consult the global + "Return the parameter value corresponding to `key' for `server'. +If no server-specific value is found consult the global environment unless `not-global' is non-nil." (let ((method (gnus-server-to-method server))) (cond ((and method (assq key (cddr method))) @@ -1763,7 +1764,7 @@ environment unless `not-global' is non-nil." (defun nnir-search-thread (header) "Make an nnir group based on the thread containing the article -header. The current server will be searched. If the registry is +header. The current server will be searched. If the registry is installed, the server that the registry reports the current article came from is also searched." (let* ((query |