From: David Bremner <david@tethera.net>
Date: Sun, 31 Jul 2022 12:46:51 +0000 (-0300)
Subject: emacs: add docstring for notmuch-show-choose-duplicate
X-Git-Tag: 0.37_rc0~10
X-Git-Url: https://git.cworth.org/git?p=notmuch;a=commitdiff_plain;h=5a47b5a884d594e74bb967dd8bb0500c7051bd79

emacs: add docstring for notmuch-show-choose-duplicate

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

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 619337b4..2dcef981 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)