]> git.notmuchmail.org Git - notmuch/blobdiff - emacs/notmuch-company.el
emacs: Increase consistency of library headers
[notmuch] / emacs / notmuch-company.el
index ac998f9b4496d39f157923846329e9f301e32848..24e7446c81bf3b97d9ead8d906f3976bbd507c41 100644 (file)
@@ -1,29 +1,34 @@
 ;;; notmuch-company.el --- Mail address completion for notmuch via company-mode  -*- lexical-binding: t -*-
-
-;; Authors: Trevor Jim <tjim@mac.com>
-;;         Michal Sojka <sojkam1@fel.cvut.cz>
 ;;
-;; Keywords: mail, completion
-
-;; This program is free software; you can redistribute it and/or modify
-;; it under the terms of the GNU General Public License as published by
+;; Copyright © Trevor Jim
+;; Copyright © Michal Sojka
+;;
+;; This file is part of Notmuch.
+;;
+;; Notmuch is free software: you can redistribute it and/or modify it
+;; under the terms of the GNU General Public License as published by
 ;; the Free Software Foundation, either version 3 of the License, or
 ;; (at your option) any later version.
-
-;; This program is distributed in the hope that it will be useful,
-;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-;; GNU General Public License for more details.
-
+;;
+;; Notmuch is distributed in the hope that it will be useful, but
+;; WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;; General Public License for more details.
+;;
 ;; You should have received a copy of the GNU General Public License
-;; along with this program.  If not, see <https://www.gnu.org/licenses/>.
+;; along with Notmuch.  If not, see <https://www.gnu.org/licenses/>.
+;;
+;; Authors: Trevor Jim <tjim@mac.com>
+;;         Michal Sojka <sojkam1@fel.cvut.cz>
+;; Keywords: mail, completion
 
 ;;; Commentary:
 
-;; To enable this, install company mode (https://company-mode.github.io/)
+;; Mail address completion for notmuch via company-mode.  To enable
+;; this, install company mode from <https://company-mode.github.io/>.
 ;;
 ;; NB company-minimum-prefix-length defaults to 3 so you don't get
-;; completion unless you type 3 characters
+;; completion unless you type 3 characters.
 
 ;;; Code:
 
     (cl-case command
       (interactive (company-begin-backend 'notmuch-company))
       (prefix (and (derived-mode-p 'message-mode)
-                  (looking-back (concat notmuch-address-completion-headers-regexp ".*")
-                                (line-beginning-position))
-                  (setq notmuch-company-last-prefix (company-grab "[:,][ \t]*\\(.*\\)" 1 (point-at-bol)))))
+                  (looking-back
+                   (concat notmuch-address-completion-headers-regexp ".*")
+                   (line-beginning-position))
+                  (setq notmuch-company-last-prefix
+                        (company-grab "[:,][ \t]*\\(.*\\)" 1 (point-at-bol)))))
       (candidates (cond
                   ((notmuch-address--harvest-ready)
                    ;; Update harvested addressed from time to time
                   (t
                    (cons :async
                          (lambda (callback)
-                           ;; First run quick asynchronous harvest based on what the user entered so far
+                           ;; First run quick asynchronous harvest
+                           ;; based on what the user entered so far
                            (notmuch-address-harvest
                             arg nil
                             (lambda (_proc _event)
                               (funcall callback (notmuch-address-matching arg))
-                              ;; Then start the (potentially long-running) full asynchronous harvest if necessary
+                              ;; Then start the (potentially long-running)
+                              ;; full asynchronous harvest if necessary
                               (notmuch-address-harvest-trigger))))))))
       (match (if (string-match notmuch-company-last-prefix arg)
                 (match-end 0)
               0))
-      (post-completion (run-hook-with-args 'notmuch-address-post-completion-functions arg))
+      (post-completion
+       (run-hook-with-args 'notmuch-address-post-completion-functions arg))
       (no-cache t))))