Re: [PATCH 13/27] emacs: place complete first sentence on first doc-string line

[David Edmondson <dme@dme.org>]

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

With a suggested rewording below...

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

> ---
>  emacs/notmuch-crypto.el |  3 +--
>  emacs/notmuch-hello.el  |  3 +--
>  emacs/notmuch-mua.el    | 11 ++++-------
>  3 files changed, 6 insertions(+), 11 deletions(-)
>
> diff --git a/emacs/notmuch-crypto.el b/emacs/notmuch-crypto.el
> index 276c9859..4fab215a 100644
> --- a/emacs/notmuch-crypto.el
> +++ b/emacs/notmuch-crypto.el
> @@ -103,8 +103,7 @@ (define-button-type 'notmuch-crypto-status-button-type
>    :supertype 'notmuch-button-type)
>  
>  (defun notmuch-crypto-insert-sigstatus-button (sigstatus from)
> -  "Insert a button describing the signature status SIGSTATUS sent
> -by user FROM."
> +  "Insert a button describing the signature status SIGSTATUS sent by user FROM."
>    (let* ((status (plist-get sigstatus :status))
>  	 (show-button t)
>  	 (face 'notmuch-crypto-signature-unknown)
> diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el
> index 003bec33..28784345 100644
> --- a/emacs/notmuch-hello.el
> +++ b/emacs/notmuch-hello.el
> @@ -372,8 +372,7 @@ (defvar notmuch-hello-hidden-sections nil
>    "List of sections titles whose contents are hidden.")
>  
>  (defvar notmuch-hello-first-run t
> -  "True if `notmuch-hello' is run for the first time, set to nil
> -afterwards.")
> +  "True if `notmuch-hello' is run for the first time, set to nil afterwards.")
>  
>  (defun notmuch-hello-nice-number (n)
>    (let (result)
> diff --git a/emacs/notmuch-mua.el b/emacs/notmuch-mua.el
> index 9d08c2c9..62d615d1 100644
> --- a/emacs/notmuch-mua.el
> +++ b/emacs/notmuch-mua.el
> @@ -73,8 +73,7 @@ (defcustom notmuch-mua-user-agent-function nil
>    :group 'notmuch-send)
>  
>  (defcustom notmuch-mua-hidden-headers nil
> -  "Headers that are added to the `message-mode' hidden headers
> -list."
> +  "Headers that are added to the `message-mode' hidden headers list."
>    :type '(repeat string)
>    :group 'notmuch-send)
>  
> @@ -167,8 +166,7 @@ (defun notmuch-mua-get-switch-function ()
>  	(t (error "Invalid value for `notmuch-mua-compose-in'"))))
>  
>  (defun notmuch-mua-maybe-set-window-dedicated ()
> -  "Set the selected window as dedicated according to
> -`notmuch-mua-compose-in'."
> +  "Set the selected window as dedicated according to `notmuch-mua-compose-in'."
>    (when (or (eq notmuch-mua-compose-in 'new-frame)
>  	    (eq notmuch-mua-compose-in 'new-window))
>      (set-window-dedicated-p (selected-window) t)))
> @@ -335,9 +333,8 @@ (define-derived-mode notmuch-message-mode message-mode "Message[Notmuch]"
>  (put 'notmuch-message-mode 'flyspell-mode-predicate 'mail-mode-flyspell-verify)
>  
>  (defun notmuch-mua-pop-to-buffer (name switch-function)
> -  "Pop to buffer NAME, and warn if it already exists and is
> -modified. This function is notmuch adaptation of
> -`message-pop-to-buffer'."
> +  "Pop to buffer NAME, and warn if it already exists and is modified.
> +This function is notmuch adaptation of `message-pop-to-buffer'."

"notmuch's adaptation" or "a notmuch adaptation", or just "an adaptation".

>    (let ((buffer (get-buffer name)))
>      (if (and buffer
>  	     (buffer-name buffer))
> -- 
> 2.29.1
> _______________________________________________
> notmuch mailing list -- notmuch@notmuchmail.org
> To unsubscribe send an email to notmuch-leave@notmuchmail.org

dme.
-- 
You bring light in.