This variable is set by calling `notmuch-address-harvest'.")
(defvar notmuch-address-full-harvest-finished nil
- "t indicates that full completion address harvesting has been
-finished. Use notmuch-address--harvest-ready to access as that
-will load a saved hash if necessary (and available).")
+ "t indicates that full completion address harvesting has been finished.
+Use notmuch-address--harvest-ready to access as that will load a
+saved hash if necessary (and available).")
(defun notmuch-address--harvest-ready ()
"Return t if there is a full address hash available.
which must take a single argument (searched string) and output a
list of completion candidates, one per line.
-Alternatively, it can be the symbol 'internal, in which case
+Alternatively, it can be the symbol `internal', in which case
internal completion is used; the variable
-`notmuch-address-internal-completion` can be used to customize
+`notmuch-address-internal-completion' can be used to customize
this case.
Finally, if this variable is nil then address completion is
(defcustom notmuch-address-internal-completion '(sent nil)
"Determines how internal address completion generates candidates.
-This should be a list of the form '(DIRECTION FILTER), where
+This should be a list of the form (DIRECTION FILTER), where
DIRECTION is either sent or received and specifies whether the
candidates are searched in messages sent by the user or received
by the user (note received by is much faster), and FILTER is
-either nil or a filter-string, such as \"date:1y..\" to append
-to the query."
+either nil or a filter-string, such as \"date:1y..\" to append to
+the query."
:type '(list :tag "Use internal address completion"
(radio
:tag "Base completion on messages you have"
"Filename to save the cached completion addresses.
All the addresses notmuch uses for address completion will be
-cached in this file. This has obvious privacy implications so you
-should make sure it is not somewhere publicly readable."
+cached in this file. This has obvious privacy implications so
+you should make sure it is not somewhere publicly readable."
:type '(choice (const :tag "Off" nil)
(file :tag "Filename"))
:group 'notmuch-send
:group 'notmuch-external)
(defcustom notmuch-address-selection-function 'notmuch-address-selection-function
- "The function to select address from given list. The function is
-called with PROMPT, COLLECTION, and INITIAL-INPUT as arguments
-(subset of what `completing-read' can be called with).
-While executed the value of `completion-ignore-case' is t.
-See documentation of function `notmuch-address-selection-function'
-to know how address selection is made by default."
+ "The function to select address from given list.
+
+The function is called with PROMPT, COLLECTION, and INITIAL-INPUT
+as arguments (subset of what `completing-read' can be called
+with). While executed the value of `completion-ignore-case'
+is t. See documentation of function
+`notmuch-address-selection-function' to know how address
+selection is made by default."
:type 'function
:group 'notmuch-send
:group 'notmuch-address
candidates))
(defun notmuch-address-options (original)
- "Returns a list of completion candidates. Uses either
-elisp-based implementation or older implementation requiring
-external commands."
+ "Return a list of completion candidates.
+Use either elisp-based implementation or older implementation
+requiring external commands."
(cond
((eq notmuch-address-command 'internal)
(unless (notmuch-address--harvest-ready)
"Version format of the save hash.")
(defun notmuch-address--get-address-hash ()
- "Returns the saved address hash as a plist.
+ "Return the saved address hash as a plist.
Returns nil if the save file does not exist, or it does not seem
to be a saved address hash."
seq)))
(defun notmuch-query-map-threads (fn threads)
- "Apply FN to every thread in THREADS. Flatten results to a list.
-
-See the function notmuch-query-get-threads for more information."
+ "Apply function FN to every thread in THREADS.
+Flatten results to a list. See the function
+`notmuch-query-get-threads' for more information."
(notmuch-query-map-aux 'notmuch-query-map-forest fn threads))
(defun notmuch-query-map-forest (fn forest)
- "Apply function to every message in a forest. Flatten results to a list.
-
-See the function notmuch-query-get-threads for more information.
-"
+ "Apply function FN to every message in FOREST.
+Flatten results to a list. See the function
+`notmuch-query-get-threads' for more information."
(notmuch-query-map-aux 'notmuch-query-map-tree fn forest))
(defun notmuch-query-map-tree (fn tree)
- "Apply function FN to every message in TREE. Flatten results to a list.
-
-See the function notmuch-query-get-threads for more information."
+ "Apply function FN to every message in TREE.
+Flatten results to a list. See the function
+`notmuch-query-get-threads' for more information."
(cons (funcall fn (car tree)) (notmuch-query-map-forest fn (cadr tree))))
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
(defun notmuch-search-foreach-result (beg end fn)
"Invoke FN for each result between BEG and END.
-FN should take one argument. It will be applied to the
-character position of the beginning of each result that overlaps
-the region between points BEG and END. As a special case, if (=
-BEG END), FN will be applied to the result containing point
-BEG."
+FN should take one argument. It will be applied to the character
+position of the beginning of each result that overlaps the region
+between points BEG and END. As a special case, if (= BEG END),
+FN will be applied to the result containing point BEG."
(let ((pos (notmuch-search-result-beginning beg))
;; End must be a marker in case fn changes the
;; text.
(provide 'rstdoc)
(defun rstdoc-batch-extract ()
- "Extract docstrings to and from the files on the command line"
+ "Extract docstrings to and from the files on the command line."
(apply #'rstdoc-extract command-line-args-left))
(defun rstdoc-extract (in-file out-file)
- "Write docstrings from IN-FILE to OUT-FILE"
+ "Write docstrings from IN-FILE to OUT-FILE."
(load-file in-file)
(let* ((definitions (cdr (assoc (expand-file-name in-file) load-history)))
(doc-hash (make-hash-table :test 'eq)))
("\\([^\\]\\)'" . "\\1`")
("^[[:space:]\t]*$" . "|br|")
("^[[:space:]\t]" . "|indent| "))
- "list of (regex . replacement) pairs")
+ "List of (regex . replacement) pairs.")
(defun rstdoc--rst-quote-string (str)
(with-temp-buffer