emacs docstrings: consistent indentation, newlines, periods

[notmuch] / emacs / notmuch-address.el

diff --git a/emacs/notmuch-address.el b/emacs/notmuch-address.el
index 15c709da70a43b6eb0aa7dc8128b8c322df11846..0d56fba70e2f3c14d3f8bd305165b6307ca3d79b 100644 (file)
--- a/emacs/notmuch-address.el
+++ b/emacs/notmuch-address.el
@@ -29,11 +29,11 @@
 (declare-function company-manual-begin "company")
 
 (defvar notmuch-address-last-harvest 0
 (declare-function company-manual-begin "company")
 
 (defvar notmuch-address-last-harvest 0

-  "Time of last address harvest")
+  "Time of last address harvest.")

 
 (defvar notmuch-address-completions (make-hash-table :test 'equal)
   "Hash of email addresses for completion during email composition.
 
 (defvar notmuch-address-completions (make-hash-table :test 'equal)
   "Hash of email addresses for completion during email composition.

-  This variable is set by calling `notmuch-address-harvest'.")
+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
 
 (defvar notmuch-address-full-harvest-finished nil
   "t indicates that full completion address harvesting has been


@@ -66,17 +66,18 @@ disabled."
          (const :tag "Disable address completion" nil)
          (string :tag "Use external completion command"))
   :group 'notmuch-send
          (const :tag "Disable address completion" nil)
          (string :tag "Use external completion command"))
   :group 'notmuch-send

+  :group 'notmuch-address

   :group 'notmuch-external)
 
 (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
   :group 'notmuch-external)
 
 (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

- 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."
+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."

   :type '(list :tag "Use internal address completion"
               (radio
                :tag "Base completion on messages you have"
   :type '(list :tag "Use internal address completion"
               (radio
                :tag "Base completion on messages you have"


@@ -93,6 +94,7 @@ This should be a list of the form '(DIRECTION FILTER), where
         (setq notmuch-address-completions (clrhash notmuch-address-completions))
         (setq notmuch-address-full-harvest-finished nil))
   :group 'notmuch-send
         (setq notmuch-address-completions (clrhash notmuch-address-completions))
         (setq notmuch-address-full-harvest-finished nil))
   :group 'notmuch-send

+  :group 'notmuch-address

   :group 'notmuch-external)
 
 (defcustom notmuch-address-save-filename nil
   :group 'notmuch-external)
 
 (defcustom notmuch-address-save-filename nil


@@ -104,6 +106,7 @@ should make sure it is not somewhere publicly readable."
   :type '(choice (const :tag "Off" nil)
                 (file :tag "Filename"))
   :group 'notmuch-send
   :type '(choice (const :tag "Off" nil)
                 (file :tag "Filename"))
   :group 'notmuch-send

+  :group 'notmuch-address

   :group 'notmuch-external)
 
 (defcustom notmuch-address-selection-function 'notmuch-address-selection-function
   :group 'notmuch-external)
 
 (defcustom notmuch-address-selection-function 'notmuch-address-selection-function


@@ -115,6 +118,7 @@ See documentation of function `notmuch-address-selection-function'
 to know how address selection is made by default."
   :type 'function
   :group 'notmuch-send
 to know how address selection is made by default."
   :type 'function
   :group 'notmuch-send

+  :group 'notmuch-address

   :group 'notmuch-external)
 
 (defcustom notmuch-address-post-completion-functions nil
   :group 'notmuch-external)
 
 (defcustom notmuch-address-post-completion-functions nil


@@ -122,8 +126,7 @@ to know how address selection is made by default."
 
 The completed address is passed as an argument to each function.
 Note that this hook will be invoked for completion in headers
 
 The completed address is passed as an argument to each function.
 Note that this hook will be invoked for completion in headers

-matching `notmuch-address-completion-headers-regexp'.
-"
+matching `notmuch-address-completion-headers-regexp'."

   :type 'hook
   :group 'notmuch-address
   :group 'notmuch-hooks)
   :type 'hook
   :group 'notmuch-address
   :group 'notmuch-hooks)


@@ -143,9 +146,10 @@ matching `notmuch-address-completion-headers-regexp'.
   (message "calling notmuch-address-message-insinuate is no longer needed"))
 
 (defcustom notmuch-address-use-company t
   (message "calling notmuch-address-message-insinuate is no longer needed"))
 
 (defcustom notmuch-address-use-company t

-  "If available, use company mode for address completion"
+  "If available, use company mode for address completion."

   :type 'boolean
   :type 'boolean

-  :group 'notmuch-send)
+  :group 'notmuch-send
+  :group 'notmuch-address)

 
 (defun notmuch-address-setup ()
   (let* ((setup-company (and notmuch-address-use-company
 
 (defun notmuch-address-setup ()
   (let* ((setup-company (and notmuch-address-use-company


@@ -154,7 +158,7 @@ matching `notmuch-address-completion-headers-regexp'.
                       #'notmuch-address-expand-name)))
       (when setup-company
        (notmuch-company-setup))
                       #'notmuch-address-expand-name)))
       (when setup-company
        (notmuch-company-setup))

-      (unless (memq pair message-completion-alist)
+      (unless (member pair message-completion-alist)

        (setq message-completion-alist
              (push pair message-completion-alist)))))
 
        (setq message-completion-alist
              (push pair message-completion-alist)))))
 


@@ -280,7 +284,7 @@ external commands."
 (defvar notmuch-address-harvest-procs '(nil . nil)
   "The currently running harvests.
 
 (defvar notmuch-address-harvest-procs '(nil . nil)
   "The currently running harvests.
 

-The car is a partial harvest, and the cdr is a full harvest")
+The car is a partial harvest, and the cdr is a full harvest.")

 
 (defun notmuch-address-harvest (&optional addr-prefix synchronous callback)
   "Collect addresses completion candidates.
 
 (defun notmuch-address-harvest (&optional addr-prefix synchronous callback)
   "Collect addresses completion candidates.


@@ -312,7 +316,7 @@ execution, CALLBACK is called when harvesting finishes."
                            (when config-query
                              (format " and (%s)" config-query)))
                  from-or-to-me-query))
                            (when config-query
                              (format " and (%s)" config-query)))
                  from-or-to-me-query))

-        (args `("address" "--format=sexp" "--format-version=2"
+        (args `("address" "--format=sexp" "--format-version=4"

                 ,(if sent "--output=recipients" "--output=sender")
                 "--deduplicate=address"
                 ,query)))
                 ,(if sent "--output=recipients" "--output=sender")
                 "--deduplicate=address"
                 ,query)))