unofficial mirror of notmuch@notmuchmail.org
 help / color / mirror / code / Atom feed
From: David Bremner <david@tethera.net>
To: David Bremner <david@tethera.net>, notmuch@notmuchmail.org
Subject: [PATCH v2] emacs: add docstring for notmuch-show-choose-duplicate
Date: Sun, 31 Jul 2022 09:46:51 -0300	[thread overview]
Message-ID: <20220731124650.2870734-1-david@tethera.net> (raw)
In-Reply-To: <20220730234551.2623885-2-david@tethera.net>

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

  reply	other threads:[~2022-07-31 12:47 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-07-30 23:45 [PATCH 1/3] doc/notmuch: merge two sections on external commands David Bremner
2022-07-30 23:45 ` [PATCH 2/3] emacs: add docstring for notmuch-show-choose-duplicate David Bremner
2022-07-31 12:46   ` David Bremner [this message]
2022-07-30 23:45 ` [PATCH 3/3] doc: add some documentation about duplicate files David Bremner
2022-08-11 10:42   ` David Bremner
2022-08-06 12:23 ` [PATCH 1/3] doc/notmuch: merge two sections on external commands David Bremner

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://notmuchmail.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20220731124650.2870734-1-david@tethera.net \
    --to=david@tethera.net \
    --cc=notmuch@notmuchmail.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://yhetil.org/notmuch.git/

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).