From 4cb3ca3585cf59400be4409b2d6162c83c051291 Mon Sep 17 00:00:00 2001 From: "Dirk-Jan C. Binnema" Date: Sun, 20 Oct 2019 14:28:41 +0300 Subject: [PATCH] mu4e-headers: Improve docstring for 'mu4e-headers-results-limit' Add a few notes on how the limit is used. --- mu4e/mu4e-headers.el | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/mu4e/mu4e-headers.el b/mu4e/mu4e-headers.el index 29a090c3..f7c49b96 100644 --- a/mu4e/mu4e-headers.el +++ b/mu4e/mu4e-headers.el @@ -109,7 +109,15 @@ indexing operation showed changes." quite a bit, especially when `mu4e-headers-include-related' is non-nil. Set to -1 for no limits, and you temporarily (for one query) ignore the limit by pressing a C-u before invoking the -search." +search. + +Note that there are a few complications when +`mu4e-headers-include-related' is enabled: mu perform *two* +queries; the first one with this limit set, and then a second +(unlimited) query for all messages that are related to the first +matches. We then limit this second result as well, favoring the +messages that were found in the first set (the \"leaders\"). +" :type '(choice (const :tag "Unlimited" -1) (integer :tag "Limit")) :group 'mu4e-headers)