aboutsummaryrefslogtreecommitdiff
path: root/emacs
diff options
context:
space:
mode:
authorDavid Bremner <david@tethera.net>2022-07-31 09:46:51 -0300
committerDavid Bremner <david@tethera.net>2022-08-11 07:25:28 -0300
commit5a47b5a884d594e74bb967dd8bb0500c7051bd79 (patch)
tree840a2ec921fe83eeab571e42a516def47ae44e14 /emacs
parentd273263d16433344cac77f54862c77535bf51e6a (diff)
emacs: add docstring for notmuch-show-choose-duplicate
It should have one in any case, but in particular it is needed for the manual.
Diffstat (limited to 'emacs')
-rw-r--r--emacs/notmuch-show.el10
1 files changed, 10 insertions, 0 deletions
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)