emacs: misc doc-string improvements

This commit is contained in:
Jonas Bernoulli 2020-11-16 22:28:31 +01:00 committed by David Bremner
parent d6cacef832
commit 53a4eb4780
3 changed files with 9 additions and 8 deletions

View file

@ -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.

View file

@ -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)

View file

@ -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)