From 53a4eb4780ef3d24af75ca36836acf7a30635136 Mon Sep 17 00:00:00 2001 From: Jonas Bernoulli Date: Mon, 16 Nov 2020 22:28:31 +0100 Subject: [PATCH] emacs: misc doc-string improvements --- emacs/notmuch-address.el | 6 +++--- emacs/notmuch-crypto.el | 4 ++-- emacs/notmuch-mua.el | 7 ++++--- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/emacs/notmuch-address.el b/emacs/notmuch-address.el index 561cc140..2c51e89b 100644 --- a/emacs/notmuch-address.el +++ b/emacs/notmuch-address.el @@ -36,9 +36,9 @@ 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).") + "Whether full completion address harvesting has 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. diff --git a/emacs/notmuch-crypto.el b/emacs/notmuch-crypto.el index 4fab215a..9e6f3a9d 100644 --- a/emacs/notmuch-crypto.el +++ b/emacs/notmuch-crypto.el @@ -27,7 +27,7 @@ (declare-function notmuch-show-get-message-id "notmuch-show" (&optional bare)) (defcustom notmuch-crypto-process-mime t - "Should cryptographic MIME parts be processed? + "Whether to process cryptographic MIME parts. If this variable is non-nil signatures in multipart/signed messages will be verified and multipart/encrypted parts will be @@ -46,7 +46,7 @@ mode." :group 'notmuch-crypto) (defcustom notmuch-crypto-get-keys-asynchronously t - "Retrieve gpg keys asynchronously." + "Whether to retrieve openpgp keys asynchronously." :type 'boolean :group 'notmuch-crypto) diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el index 05763928..29a2538b 100644 --- a/emacs/notmuch-mua.el +++ b/emacs/notmuch-mua.el @@ -82,10 +82,11 @@ If this is `nil' then no `User-Agent:' will be generated." :group 'notmuch) (defcustom notmuch-mua-cite-function 'message-cite-original - "*Function for citing an original message. + "Function for citing an original message. + Predefined functions include `message-cite-original' and -`message-cite-original-without-signature'. -Note that these functions use `mail-citation-hook' if that is non-nil." +`message-cite-original-without-signature'. Note that these +functions use `mail-citation-hook' if that is non-nil." :type '(radio (function-item message-cite-original) (function-item message-cite-original-without-signature) (function-item sc-cite-original) -- 2.43.0