]> git.cworth.org Git - notmuch/commitdiff
emacs: add docstring for notmuch-show-choose-duplicate
authorDavid Bremner <david@tethera.net>
Sun, 31 Jul 2022 12:46:51 +0000 (09:46 -0300)
committerDavid Bremner <david@tethera.net>
Thu, 11 Aug 2022 10:25:28 +0000 (07:25 -0300)
It should have one in any case, but in particular it is needed for the
manual.

emacs/notmuch-show.el

index 619337b4461ffd1b2e2bb479e0eeee4c3ecf7228..2dcef98167c9e0e1162d515bdf8829de687099f0 100644 (file)
@@ -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)