[PATCH v2] emacs: add docstring for notmuch-show-choose-duplicate

Subject: [PATCH v2] emacs: add docstring for notmuch-show-choose-duplicate

Date: Sun, 31 Jul 2022 09:46:51 -0300

To: David Bremner, notmuch@notmuchmail.org

Cc:

From: David Bremner

It should have one in any case, but in particular it is needed for the
manual.
---

I realized my first attempt at a docstring didn't work well in the manual.

 emacs/notmuch-show.el | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 1bc3b319..6653358c 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -1135,6 +1135,16 @@ is t, hide the part initially and show the button."
 (make-variable-buffer-local 'notmuch-show-previous-subject)
 
 (defun notmuch-show-choose-duplicate (duplicate)
+  "Display message file with index DUPLICATE in place of the current one.
+
+Message file indices are based on the order the files are
+discovered by `notmuch new' (and hence are somewhat arbitrary),
+and correspond to those passed to the \"\\-\\-duplicate\" arguments
+to the CLI.
+
+When called interactively, the function will prompt for the index
+of the file to display.  An error will be signaled if the index
+is out of range."
   (interactive "Nduplicate: ")
   (let ((count (length (notmuch-show-get-prop :filename))))
     (when (or (> duplicate count)
-- 
2.35.2

_______________________________________________
notmuch mailing list -- notmuch@notmuchmail.org
To unsubscribe send an email to notmuch-leave@notmuchmail.org

Thread: