[PATCH] Two tiny clarifications for notmuch-show-mode's docstring

[PATCH] Two tiny clarifications for notmuch-show-mode's docstring

[Jorge P. de Morais Neto]

[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: 0001-emacs-Two-small-clarifications-for-notmuch-show-mode.patch --]
[-- Type: text/x-diff, Size: 1921 bytes --]

From edf36bb0d276d2cebe1e3b01dc953b508043a71f Mon Sep 17 00:00:00 2001
From: "Jorge P. de Morais Neto" <jorge+git@disroot.org>
Date: Thu, 28 Oct 2021 19:33:34 -0300
Subject: [PATCH] emacs: Two small clarifications for notmuch-show-mode's
 docstring

- Prominently inform that `notmuch-show-advance-and-archive' can
  archive the current thread
- Clarify that `notmuch-show-next-message' and
  `notmuch-show-previous-message' change the "unread" tag.

Signed-off-by: Jorge P. de Morais Neto <jorge@disroot.org>
---
 emacs/notmuch-show.el | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/emacs/notmuch-show.el b/emacs/notmuch-show.el
index 4de3e423..b4afb076 100644
--- a/emacs/notmuch-show.el
+++ b/emacs/notmuch-show.el
@@ -1532,13 +1532,14 @@ which \\[notmuch-show-next-button] and \\[notmuch-show-previous-button] are help
 
 Reading the thread sequentially is well-supported by pressing
 \\[notmuch-show-advance-and-archive]. This will scroll the current message (if necessary), advance
-to the next message, or advance to the next thread (if already on
-the last message of a thread).
+to the next message, or archive current thread and advance to the next
+(if already on the last message of a thread).
 
 Other commands are available to read or manipulate the thread
 more selectively, (such as '\\[notmuch-show-next-message]' and '\\[notmuch-show-previous-message]' to advance to messages
-without removing any tags, and '\\[notmuch-show-archive-thread]' to archive an entire thread
-without scrolling through with \\[notmuch-show-advance-and-archive]).
+without removing any tags other than \"unread\", and
+'\\[notmuch-show-archive-thread]' to archive an entire thread without
+scrolling through with \\[notmuch-show-advance-and-archive]).
 
 You can add or remove arbitrary tags from the current message with
 '\\[notmuch-show-add-tag]' or '\\[notmuch-show-remove-tag]'.
-- 
2.33.1


[-- Attachment #2: Type: text/plain, Size: 1310 bytes --]


From my previous email message from 2020-11-25
(id:878sape5a9.fsf@disroot.org):

>> The introduction of help buffer for Notmuch-Show (reached by hitting
>> <?>) describes the <SPC> command without mentioning that it can
>> archive the thread; only in <SPC> specific description (which does
>> not fit in the same window; one has to scroll) does it mention the
>> archiving behavior.  I believe the archiving behavior should also be
>> mentioned in the introduction, lest the user unwittingly archive a
>> thread she wasn't supposed to.

David Bremner later said on 2021-10-10 (id:87o87ws6np.fsf@tethera.net):

> I personally don't think archiving is that destructive, if someone
> wants to improve this wording, it is the docstring for
> notmuch-show-mode

So now I provide the attached patch on its own dedicated thread,
according to David Bremner instructions today
(id:87o85vql88.fsf@tethera.net).

Please give feedback.  I have a general grave obsession with details, so
I need to calibrate my attention to detail through feedback.

Regards!

-- 
- Many people hate injustice but few check the facts; this causes more
  injustice.  Ask me about <https://stallmansupport.org>
- I am Brazilian.  I hope my English is correct and I welcome feedback.
- https://www.defectivebydesign.org
- https://www.gnu.org

[-- Attachment #3: Type: text/plain, Size: 0 bytes --]