emacs: wrap docstrings

Suppress byte-compiler warnings about >80 character docstrings.
This commit is contained in:
David Bremner 2023-10-06 19:56:17 -03:00
parent fc1c81c378
commit c273266503
3 changed files with 32 additions and 19 deletions

View file

@ -717,7 +717,8 @@ with `notmuch-hello-query-counts'."
"Keymap for \"notmuch hello\" buffers.") "Keymap for \"notmuch hello\" buffers.")
(define-derived-mode notmuch-hello-mode fundamental-mode "notmuch-hello" (define-derived-mode notmuch-hello-mode fundamental-mode "notmuch-hello"
"Major mode for convenient notmuch navigation. This is your entry portal into notmuch. "Major mode for convenient notmuch navigation. This is your entry
portal into notmuch.
Saved searches are \"bookmarks\" for arbitrary queries. Hit RET Saved searches are \"bookmarks\" for arbitrary queries. Hit RET
or click on a saved search to view matching threads. Edit saved or click on a saved search to view matching threads. Edit saved
@ -853,7 +854,8 @@ Complete list of currently available key bindings:
(widget-create 'notmuch-search-item :value search :size width))))) (widget-create 'notmuch-search-item :value search :size width)))))
(defun notmuch-hello-insert-searches (title query-list &rest options) (defun notmuch-hello-insert-searches (title query-list &rest options)
"Insert a section with TITLE showing a list of buttons made from QUERY-LIST. "Insert a section with TITLE showing a list of buttons made from
QUERY-LIST.
QUERY-LIST should ideally be a plist but for backwards QUERY-LIST should ideally be a plist but for backwards
compatibility other forms are also accepted (see compatibility other forms are also accepted (see
@ -867,13 +869,16 @@ Supports the following entries in OPTIONS as a plist:
:show-empty-searches - show buttons with no matching messages :show-empty-searches - show buttons with no matching messages
:hide-if-empty - hide if no buttons would be shown :hide-if-empty - hide if no buttons would be shown
(only makes sense without :show-empty-searches) (only makes sense without :show-empty-searches)
:filter - This can be a function that takes the search query as its argument and :filter - This can be a function that takes the search query as
returns a filter to be used in conjunction with the query for that search or nil its argument and returns a filter to be used in conjunction
to hide the element. This can also be a string that is used as a combined with with the query for that search or nil to hide the
each query using \"and\". element. This can also be a string that is used as a combined
:filter-count - Separate filter to generate the count displayed each search. Accepts with each query using \"and\".
the same values as :filter. If :filter and :filter-count are specified, this :filter-count - Separate filter to generate the count displayed
will be used instead of :filter, not in conjunction with it." each search. Accepts the same values as :filter. If :filter
and :filter-count are specified, this will be used instead of
:filter, not in conjunction with it."
(widget-insert title ": ") (widget-insert title ": ")
(when (and notmuch-hello-first-run (plist-get options :initially-hidden)) (when (and notmuch-hello-first-run (plist-get options :initially-hidden))
(add-to-list 'notmuch-hello-hidden-sections title)) (add-to-list 'notmuch-hello-hidden-sections title))

View file

@ -2507,10 +2507,12 @@ kill-ring."
(defun notmuch-show-stash-mlarchive-link (&optional mla) (defun notmuch-show-stash-mlarchive-link (&optional mla)
"Copy an ML Archive URI for the current message to the kill-ring. "Copy an ML Archive URI for the current message to the kill-ring.
This presumes that the message is available at the selected Mailing List Archive. This presumes that the message is available at the selected
Mailing List Archive.
If optional argument MLA is non-nil, use the provided key instead of prompting If optional argument MLA is non-nil, use the provided key instead
the user (see `notmuch-show-stash-mlarchive-link-alist')." of prompting the user (see
`notmuch-show-stash-mlarchive-link-alist')."
(interactive) (interactive)
(let ((url (cdr (assoc (let ((url (cdr (assoc
(or mla (or mla
@ -2527,12 +2529,15 @@ the user (see `notmuch-show-stash-mlarchive-link-alist')."
(concat url (notmuch-show-get-message-id t)))))) (concat url (notmuch-show-get-message-id t))))))
(defun notmuch-show-stash-mlarchive-link-and-go (&optional mla) (defun notmuch-show-stash-mlarchive-link-and-go (&optional mla)
"Copy an ML Archive URI for the current message to the kill-ring and visit it. "Copy an ML Archive URI for the current message to the
kill-ring and visit it.
This presumes that the message is available at the selected Mailing List Archive. This presumes that the message is available at the selected
Mailing List Archive.
If optional argument MLA is non-nil, use the provided key instead of prompting If optional argument MLA is non-nil, use the provided key instead
the user (see `notmuch-show-stash-mlarchive-link-alist')." of prompting the user (see
`notmuch-show-stash-mlarchive-link-alist')."
(interactive) (interactive)
(notmuch-show-stash-mlarchive-link mla) (notmuch-show-stash-mlarchive-link mla)
(browse-url (current-kill 0 t))) (browse-url (current-kill 0 t)))

View file

@ -200,7 +200,8 @@ Note that the author string should not contain whitespace
(defface notmuch-tree-match-tree-face (defface notmuch-tree-match-tree-face
nil nil
"Face used in tree mode for the thread tree block graphics in messages matching the query." "Face used in tree mode for the thread tree block graphics in
messages matching the query."
:group 'notmuch-tree :group 'notmuch-tree
:group 'notmuch-faces) :group 'notmuch-faces)
@ -239,7 +240,8 @@ Note that the author string should not contain whitespace
(defface notmuch-tree-no-match-tree-face (defface notmuch-tree-no-match-tree-face
nil nil
"Face used in tree mode for the thread tree block graphics in messages matching the query." "Face used in tree mode for the thread tree block graphics in
messages matching the query."
:group 'notmuch-tree :group 'notmuch-tree
:group 'notmuch-faces) :group 'notmuch-faces)
@ -1047,7 +1049,8 @@ message together with all its descendents."
(notmuch-tree-insert-thread replies (1+ depth) tree-status))) (notmuch-tree-insert-thread replies (1+ depth) tree-status)))
(defun notmuch-tree-insert-thread (thread depth tree-status) (defun notmuch-tree-insert-thread (thread depth tree-status)
"Insert the collection of sibling sub-threads THREAD at depth DEPTH in the current forest." "Insert the collection of sibling sub-threads THREAD at depth
DEPTH in the current forest."
(let ((n (length thread))) (let ((n (length thread)))
(cl-loop for tree in thread (cl-loop for tree in thread
for count from 1 to n for count from 1 to n