From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp11.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms9.migadu.com with LMTPS id iPMuAGCbIGVuQAEA9RJhRA:P1 (envelope-from ) for ; Sat, 07 Oct 2023 01:42:24 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:4789::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp11.migadu.com with LMTPS id iPMuAGCbIGVuQAEA9RJhRA (envelope-from ) for ; Sat, 07 Oct 2023 01:42:24 +0200 Received: from mail.notmuchmail.org (yantan.tethera.net [135.181.149.255]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits) server-digest SHA256) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id B2ADC65050 for ; Sat, 7 Oct 2023 01:42:23 +0200 (CEST) Authentication-Results: aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1696635743; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references:list-id:list-help: list-owner:list-unsubscribe:list-subscribe:list-post; bh=XKMT8QQdSGYM57EhKi0KNoLIQ94/+j6Iu7SBmoah+Bw=; b=WHgpz8dBnqpY3LiBwfIG0v5/57Uk9Y7ZXvM8+Avv9TeygBtyW/mvgwyE1qoDxuLQcOjL/8 mh002NA8Leew/Jznrt2DEBRPgj8/U3hUDih0IBDDHYg8Y9Y7G4TImAPkcjg8NyYPEfoVh8 WxfMowTXB5UYuSJBD6Bkl0AaPBhHKOzi4NXJ9SqgIznZXdnB025r97SMkIGzblBx1jW2dt Id3BlT83Di3fIxNCJihWAMukrGfscG+gnOAw/0aKBTa0Mg6isHTvEo2hVgryWUKTJXsHYl V64TJ/w1O+n830Rvxk1ypU0sqtaIO6+tu2g8X2JTn9jkqC7uus0vpIpSVS9Tmg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=none; dmarc=none; spf=pass (aspmx1.migadu.com: domain of notmuch-bounces@notmuchmail.org designates 135.181.149.255 as permitted sender) smtp.mailfrom=notmuch-bounces@notmuchmail.org ARC-Seal: i=1; s=key1; d=yhetil.org; t=1696635743; a=rsa-sha256; cv=none; b=Y1trxKMmY/HiDBPPVr+gtpyjW67tKvcZqpAoZYA9yvDMI/tL5m0atkKCJMJTzhxpUbxOMc YoFvAxuJmYk6Ty5fQ/EPmOhR3Ufk0lUc0taZu0zjfRra6ar4CciHW/FzdNq4Ef8KCBWu2O +Dt6CKYk6O4h66hv3ZJOP/xc8AKYwvz0vSgngyv/bZa3MgYOLGvOB34YQp6lm2MH+ERe64 DCCPXn/rNIV2AyYv8jM+WfqeuzXMTQICpzV9N3YqKnLrQnpw9Uvwr+qlrCLPUGzX3uh2NO C/J+LeTG/zqjNeweN+XyfObKP9mL+hIx8SFXkEQrNQrGJUF2tRGfstGboB4xMg== Received: from yantan.tethera.net (localhost [127.0.0.1]) by mail.notmuchmail.org (Postfix) with ESMTP id 19E0C60AAE; Fri, 6 Oct 2023 23:42:04 +0000 (UTC) Received: from phubs.tethera.net (phubs.tethera.net [IPv6:2607:5300:60:3a9d::1]) by mail.notmuchmail.org (Postfix) with ESMTPS id B27F660AAC for ; Fri, 6 Oct 2023 23:42:01 +0000 (UTC) Received: from tethera.net (fctnnbsc51w-159-2-210-253.dhcp-dynamic.fibreop.nb.bellaliant.net [159.2.210.253]) by phubs.tethera.net (Postfix) with ESMTPS id EC95218006E; Fri, 6 Oct 2023 20:41:59 -0300 (ADT) Received: (nullmailer pid 2262855 invoked by uid 1000); Fri, 06 Oct 2023 23:41:57 -0000 From: David Bremner To: notmuch@notmuchmail.org Subject: [PATCH 2/4] emacs: wrap docstrings Date: Fri, 6 Oct 2023 20:41:54 -0300 Message-Id: <20231006234156.2262812-3-david@tethera.net> X-Mailer: git-send-email 2.40.1 In-Reply-To: <20231006234156.2262812-1-david@tethera.net> References: <20231006234156.2262812-1-david@tethera.net> MIME-Version: 1.0 Message-ID-Hash: JOBTYM4O3QQU6PDSOSUTOLATKIOJKOLV X-Message-ID-Hash: JOBTYM4O3QQU6PDSOSUTOLATKIOJKOLV X-MailFrom: bremner@tethera.net X-Mailman-Rule-Misses: dmarc-mitigation; no-senders; approved; emergency; loop; banned-address; member-moderation; header-match-notmuch.notmuchmail.org-0; nonmember-moderation; administrivia; implicit-dest; max-recipients; max-size; news-moderation; no-subject; digests; suspicious-header X-Mailman-Version: 3.3.3 Precedence: list List-Id: "Use and development of the notmuch mail system." List-Help: List-Owner: List-Post: List-Subscribe: List-Unsubscribe: Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Migadu-Country: DE X-Migadu-Flow: FLOW_IN X-Migadu-Queue-Id: B2ADC65050 X-Spam-Score: 0.22 X-Migadu-Spam-Score: 0.22 X-Migadu-Scanner: mx1.migadu.com X-TUID: qKJGKftXeBT6 Suppress byte-compiler warnings about >80 character docstrings. --- emacs/notmuch-hello.el | 23 ++++++++++++++--------- emacs/notmuch-show.el | 19 ++++++++++++------- emacs/notmuch-tree.el | 9 ++++++--- 3 files changed, 32 insertions(+), 19 deletions(-) diff --git a/emacs/notmuch-hello.el b/emacs/notmuch-hello.el index 2d4fdc02..47ece536 100644 --- a/emacs/notmuch-hello.el +++ b/emacs/notmuch-hello.el @@ -717,7 +717,8 @@ with `notmuch-hello-query-counts'." "Keymap for \"notmuch hello\" buffers.") (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 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))))) (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 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 :hide-if-empty - hide if no buttons would be shown (only makes sense without :show-empty-searches) -:filter - This can be a function that takes the search query as its argument and - returns a filter to be used in conjunction with the query for that search or nil - to hide the element. This can also be a string that is used as a combined with - each query using \"and\". -:filter-count - Separate filter to generate the count displayed 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." +:filter - This can be a function that takes the search query as + its argument and returns a filter to be used in conjunction + with the query for that search or nil to hide the + element. This can also be a string that is used as a combined + with each query using \"and\". +:filter-count - Separate filter to generate the count displayed + 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 ": ") (when (and notmuch-hello-first-run (plist-get options :initially-hidden)) (add-to-list 'notmuch-hello-hidden-sections title)) diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el index 4cc5aa57..4c0ad74d 100644 --- a/emacs/notmuch-show.el +++ b/emacs/notmuch-show.el @@ -2507,10 +2507,12 @@ kill-ring." (defun notmuch-show-stash-mlarchive-link (&optional mla) "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 -the user (see `notmuch-show-stash-mlarchive-link-alist')." +If optional argument MLA is non-nil, use the provided key instead +of prompting the user (see +`notmuch-show-stash-mlarchive-link-alist')." (interactive) (let ((url (cdr (assoc (or mla @@ -2527,12 +2529,15 @@ the user (see `notmuch-show-stash-mlarchive-link-alist')." (concat url (notmuch-show-get-message-id t)))))) (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 -the user (see `notmuch-show-stash-mlarchive-link-alist')." +If optional argument MLA is non-nil, use the provided key instead +of prompting the user (see +`notmuch-show-stash-mlarchive-link-alist')." (interactive) (notmuch-show-stash-mlarchive-link mla) (browse-url (current-kill 0 t))) diff --git a/emacs/notmuch-tree.el b/emacs/notmuch-tree.el index b58fa6a6..7fa403fc 100644 --- a/emacs/notmuch-tree.el +++ b/emacs/notmuch-tree.el @@ -200,7 +200,8 @@ Note that the author string should not contain whitespace (defface notmuch-tree-match-tree-face 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-faces) @@ -239,7 +240,8 @@ Note that the author string should not contain whitespace (defface notmuch-tree-no-match-tree-face 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-faces) @@ -1047,7 +1049,8 @@ message together with all its descendents." (notmuch-tree-insert-thread replies (1+ 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))) (cl-loop for tree in thread for count from 1 to n -- 2.40.1