Re: [PATCH 15/27] emacs: misc doc-string improvements

Subject: Re: [PATCH 15/27] emacs: misc doc-string improvements

Date: Sun, 15 Nov 2020 20:48:27 +0000

To: Jonas Bernoulli, notmuch@notmuchmail.org

Cc:

From: David Edmondson


On Sunday, 2020-11-08 at 20:02:59 +01, Jonas Bernoulli wrote:

Minor suggestion below...

Reviewed-by: David Edmondson <dme@dme.org>

> ---
>  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..04353522 100644
> --- a/emacs/notmuch-address.el
> +++ b/emacs/notmuch-address.el
> @@ -36,9 +36,9 @@ (defvar notmuch-address-completions (make-hash-table :test 'equal)
>  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

Quotes to indicate that `notmuch-address--harvest-ready' is a function?

> +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 @@ (require 'notmuch-lib)
>  (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 @@ (defcustom notmuch-crypto-process-mime t
>    :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 62d615d1..821bb324 100644
> --- a/emacs/notmuch-mua.el
> +++ b/emacs/notmuch-mua.el
> @@ -82,10 +82,11 @@ (defgroup notmuch-reply nil
>    :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.29.1
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org

dme.
-- 
I'm not the reason you're looking for redemption.
_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: