[PATCH v2 07/23] emacs: shorten/replace first sentence of a few doc-strings

Subject: [PATCH v2 07/23] emacs: shorten/replace first sentence of a few doc-strings

Date: Mon, 16 Nov 2020 22:28:27 +0100

To: notmuch@notmuchmail.org

Cc:

From: Jonas Bernoulli


The first sentence should fit on the first line.  It is okay if
the first sentence/line does not contain all the information that
the rest of the doc-string covers.
---
 emacs/notmuch-show.el | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 6a757687..14250d34 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -2347,7 +2347,9 @@ (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
   (browse-url (current-kill 0 t)))
 
 (defun notmuch-show-stash-git-helper (addresses prefix)
-  "Escape, trim, quote, and add PREFIX to each address in list of ADDRESSES, and return the result as a single string."
+  "Normalize all ADDRESSES while adding PREFIX.
+Escape, trim, quote and add PREFIX to each address in list
+of ADDRESSES, and return the result as a single string."
   (mapconcat (lambda (x)
 	       (concat prefix "\""
 		       ;; escape double-quotes
@@ -2360,10 +2362,12 @@ (defun notmuch-show-stash-git-helper (addresses prefix)
 	     addresses " "))
 
 (put 'notmuch-show-stash-git-send-email 'notmuch-prefix-doc
-     "Copy From/To/Cc of current message to kill-ring in a form suitable for pasting to git send-email command line.")
+     "Copy From/To/Cc of current message to kill-ring.
+Use a form suitable for pasting to git send-email command line.")
 
 (defun notmuch-show-stash-git-send-email (&optional no-in-reply-to)
-  "Copy From/To/Cc/Message-Id of current message to kill-ring in a form suitable for pasting to git send-email command line.
+  "Copy From/To/Cc/Message-Id of current message to kill-ring.
+Use a form suitable for pasting to git send-email command line.
 
 If invoked with a prefix argument (or NO-IN-REPLY-TO is non-nil),
 omit --in-reply-to=<Message-Id>."
-- 
2.29.1
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: