emacs: Improve doc-strings

[notmuch] / emacs / notmuch-query.el

diff --git a/emacs/notmuch-query.el b/emacs/notmuch-query.el
index 436ad160a05b8c0f9a698de1ba9fb025fc272912..3cfccbc3e891aebb9829886457018e302d42f0ed 100644 (file)
--- a/emacs/notmuch-query.el
+++ b/emacs/notmuch-query.el
@@ -28,11 +28,10 @@
 
 A thread is a forest or list of trees. A tree is a two element
 list where the first element is a message, and the second element
-is a possibly empty forest of replies.
-"
-  (let ((args '("show" "--format=sexp" "--format-version=1")))
-    (if notmuch-show-process-crypto
-       (setq args (append args '("--decrypt"))))
+is a possibly empty forest of replies."
+  (let ((args '("show" "--format=sexp" "--format-version=4")))
+    (when notmuch-show-process-crypto
+      (setq args (append args '("--decrypt=true"))))
     (setq args (append args search-terms))
     (apply #'notmuch-call-notmuch-sexp args)))
 
@@ -40,37 +39,36 @@ is a possibly empty forest of replies.
 ;; Mapping functions across collections of messages.
 
 (defun notmuch-query-map-aux  (mapper function seq)
-  "private function to do the actual mapping and flattening"
+  "Private function to do the actual mapping and flattening."
   (apply 'append
         (mapcar
-          (lambda (tree)
-            (funcall mapper function tree))
-          seq)))
+         (lambda (tree)
+           (funcall mapper function tree))
+         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))))
 
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;; Predefined queries
 
 (defun notmuch-query-get-message-ids (&rest search-terms)
-  "Return a list of message-ids of messages that match SEARCH-TERMS"
+  "Return a list of message-ids of messages that match SEARCH-TERMS."
   (notmuch-query-map-threads
    (lambda (msg) (plist-get msg :id))
    (notmuch-query-get-threads search-terms)))